Create Spend Policy

client.Billing.SpendPolicies.New(ctx, params) (*SpendPolicyNewResponse, error)

POST/accounts/{account_id}/billing/spend-policies

Creates a spend policy. Each account can have only one enabled usage_block policy per product. A second one returns 409. There is no limit on notification policies.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

params SpendPolicyNewParams

AccountID param.Field[string]

Path param: Represents a Cloudflare resource identifier tag.

maxLength32

Action param.Field[SpendPolicyNewParamsAction]

Body param: The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.

const SpendPolicyNewParamsActionNotification SpendPolicyNewParamsAction = "notification"

const SpendPolicyNewParamsActionUsageBlock SpendPolicyNewParamsAction = "usage_block"

Enabled param.Field[bool]

Body param: Whether the policy is evaluated.

Name param.Field[string]

Body param: Display name of the policy. After surrounding whitespace is trimmed, it must be 1 to 200 bytes long. The value is stored as sent, untrimmed.

minLength1

ProductID param.Field[SpendPolicyNewParamsProductID]

Body param: The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.

const SpendPolicyNewParamsProductIDWorkers SpendPolicyNewParamsProductID = "workers"

const SpendPolicyNewParamsProductIDDurableObjects SpendPolicyNewParamsProductID = "durable_objects"

ThresholdCents param.Field[int64]

Body param: The spend threshold for the current billing period, in US cents. Must be greater than zero.

formatint64

minimum1

NotificationEmail param.Field[string]Optional

Body param: Email address that receives notifications. Required when action is notification. When set, it must be a bare address (user@example.com); display-name forms such as Name <user@example.com> are rejected.

formatemail

ReturnsExpand Collapse

type SpendPolicyNewResponse struct{…}

A spend policy.

ID string

The unique identifier of the spend policy.

formatuuid

AccountID int64

Internal numeric ID of the account that owns the policy. This is not the account tag used in the path.

formatint64

Action SpendPolicyNewResponseAction

The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.

One of the following:

const SpendPolicyNewResponseActionNotification SpendPolicyNewResponseAction = "notification"

const SpendPolicyNewResponseActionUsageBlock SpendPolicyNewResponseAction = "usage_block"

Enabled bool

Whether the policy is evaluated.

Name string

Display name of the policy.

NotificationEmail string

Email address that receives notifications. An empty string when none is set.

ProductID SpendPolicyNewResponseProductID

The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.

One of the following:

const SpendPolicyNewResponseProductIDWorkers SpendPolicyNewResponseProductID = "workers"

const SpendPolicyNewResponseProductIDDurableObjects SpendPolicyNewResponseProductID = "durable_objects"

ThresholdCents int64

The spend threshold for the current billing period, in US cents.

formatint64

Version int64

Optimistic-concurrency version. It starts at 1 and goes up by one on every update or delete. This value is also returned in ETag.

formatint64

minimum1

CurrentState SpendPolicyNewResponseCurrentStateOptional

Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.

BalanceCents int64

formatint64

BillingPeriodEnd Time

formatdate-time

BillingPeriodStart Time

formatdate-time

Enforcement SpendPolicyNewResponseCurrentStateEnforcement

Durable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.

AppliedGeneration int64

formatint64

DeliveryStatus SpendPolicyNewResponseCurrentStateEnforcementDeliveryStatus

One of the following:

const SpendPolicyNewResponseCurrentStateEnforcementDeliveryStatusPending SpendPolicyNewResponseCurrentStateEnforcementDeliveryStatus = "pending"

const SpendPolicyNewResponseCurrentStateEnforcementDeliveryStatusLeased SpendPolicyNewResponseCurrentStateEnforcementDeliveryStatus = "leased"

const SpendPolicyNewResponseCurrentStateEnforcementDeliveryStatusRetry SpendPolicyNewResponseCurrentStateEnforcementDeliveryStatus = "retry"

const SpendPolicyNewResponseCurrentStateEnforcementDeliveryStatusSucceeded SpendPolicyNewResponseCurrentStateEnforcementDeliveryStatus = "succeeded"

DesiredGeneration int64

formatint64

DesiredState SpendPolicyNewResponseCurrentStateEnforcementDesiredState

One of the following:

const SpendPolicyNewResponseCurrentStateEnforcementDesiredStateActive SpendPolicyNewResponseCurrentStateEnforcementDesiredState = "active"

const SpendPolicyNewResponseCurrentStateEnforcementDesiredStateInactive SpendPolicyNewResponseCurrentStateEnforcementDesiredState = "inactive"

ExpiresAt Time

formatdate-time

EvaluatedAt Time

Evaluation time; not the timestamp of the latest usage event.

formatdate-time

Status SpendPolicyNewResponseCurrentStateStatus

Threshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.

One of the following:

const SpendPolicyNewResponseCurrentStateStatusDisabled SpendPolicyNewResponseCurrentStateStatus = "disabled"

const SpendPolicyNewResponseCurrentStateStatusNoCurrentPeriod SpendPolicyNewResponseCurrentStateStatus = "no_current_period"

const SpendPolicyNewResponseCurrentStateStatusUnavailable SpendPolicyNewResponseCurrentStateStatus = "unavailable"

const SpendPolicyNewResponseCurrentStateStatusBelowLimit SpendPolicyNewResponseCurrentStateStatus = "below_limit"

const SpendPolicyNewResponseCurrentStateStatusLimitReached SpendPolicyNewResponseCurrentStateStatus = "limit_reached"

Create Spend Policy

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/billing"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  spendPolicy, err := client.Billing.SpendPolicies.New(context.TODO(), billing.SpendPolicyNewParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Action: cloudflare.F(billing.SpendPolicyNewParamsActionNotification),
    Enabled: cloudflare.F(true),
    Name: cloudflare.F("Durable Objects alert"),
    ProductID: cloudflare.F(billing.SpendPolicyNewParamsProductIDDurableObjects),
    ThresholdCents: cloudflare.F(int64(100)),
    NotificationEmail: cloudflare.F("billing@example.com"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", spendPolicy.ID)
}

{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": {
    "id": "6f1c2b8e-3d4a-4f5b-9c6d-7e8f9a0b1c2d",
    "account_id": 1234567,
    "action": "notification",
    "enabled": true,
    "name": "Workers cap",
    "notification_email": "billing@example.com",
    "product_id": "workers",
    "threshold_cents": 100,
    "version": 1,
    "current_state": {
      "balance_cents": 0,
      "billing_period_end": "2019-12-27T18:11:19.117Z",
      "billing_period_start": "2019-12-27T18:11:19.117Z",
      "enforcement": {
        "applied_generation": 0,
        "delivery_status": "pending",
        "desired_generation": 0,
        "desired_state": "active",
        "expires_at": "2019-12-27T18:11:19.117Z"
      },
      "evaluated_at": "2019-12-27T18:11:19.117Z",
      "status": "disabled"
    }
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": {
    "id": "6f1c2b8e-3d4a-4f5b-9c6d-7e8f9a0b1c2d",
    "account_id": 1234567,
    "action": "notification",
    "enabled": true,
    "name": "Workers cap",
    "notification_email": "billing@example.com",
    "product_id": "workers",
    "threshold_cents": 100,
    "version": 1,
    "current_state": {
      "balance_cents": 0,
      "billing_period_end": "2019-12-27T18:11:19.117Z",
      "billing_period_start": "2019-12-27T18:11:19.117Z",
      "enforcement": {
        "applied_generation": 0,
        "delivery_status": "pending",
        "desired_generation": 0,
        "desired_state": "active",
        "expires_at": "2019-12-27T18:11:19.117Z"
      },
      "evaluated_at": "2019-12-27T18:11:19.117Z",
      "status": "disabled"
    }
  },
  "success": true
}