Create Billing Profile

POST/accounts/{account_id}/billing/profile

Creates a billing profile for an account.

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

Accepted Permissions (at least one required)

Billing Write

Path ParametersExpand Collapse

account_id: string

Identifier

maxLength32

Body ParametersJSONExpand Collapse

address: optional string

Street address line 1.

address2: optional string

Street address line 2 (apt, suite, etc.).

billing_email: optional string

Primary billing email address.

buying_rate_plan: optional string

Rate plan being purchased right after profile setup.

captcha_challenge_jwt: optional string

Captcha challenge JWT issued during onboarding.

cf_turnstile_response: optional string

Cloudflare Turnstile response.

city: optional string

City on the billing profile.

company: optional string

Company name on the billing profile.

country: optional string

ISO 3166-1 alpha-2 country code.

first_name: optional string

First name on the billing profile.

h_captcha_response: optional string

hCaptcha response.

last_name: optional string

Last name on the billing profile.

preferred_locale: optional string

Preferred locale for invoice rendering (BCP 47).

secondary_billing_email: optional string

Secondary billing email address for CC on invoices.

state: optional string

State or region on the billing profile.

tax_id_type: optional string

Type of tax ID provided.

telephone: optional string

Contact phone number.

vat: optional string

VAT identifier.

zipcode: optional string

ZIP or postal code.

ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

result: object { id, account_type, address, 35 more }

id: optional string

Billing item identifier tag.

maxLength32

account_type: optional string

address: optional string

address2: optional string

balance: optional string

card_expiry_month: optional number

card_expiry_year: optional number

card_number: optional string

city: optional string

company: optional string

country: optional string

created_on: optional string

formatdate-time

device_data: optional string

edited_on: optional string

formatdate-time

enterprise_billing_email: optional string

enterprise_primary_email: optional string

first_name: optional string

is_partner: optional boolean

last_name: optional string

next_bill_date: optional string

formatdate-time

payment_address: optional string

payment_address2: optional string

payment_city: optional string

payment_country: optional string

payment_email: optional string

payment_first_name: optional string

payment_gateway: optional string

payment_last_name: optional string

payment_nonce: optional string

payment_state: optional string

payment_zipcode: optional string

primary_email: optional string

state: optional string

tax_id_type: optional string

telephone: optional string

validation_code: optional string

vat: optional string

zipcode: optional string

success: true

Whether the API call was successful

Create Billing Profile

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/billing/profile \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "address": "123 Main Street",
          "address2": "Apt 1",
          "billing_email": "billing@example.com",
          "city": "Anytown",
          "company": "Example Inc",
          "country": "US",
          "first_name": "John",
          "last_name": "Doe",
          "preferred_locale": "en-US",
          "secondary_billing_email": "secondary@example.com",
          "state": "CA",
          "telephone": "+1-555-555-5555",
          "zipcode": "94103"
        }'

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "b69a9f3492637782896352daae219e7d",
    "account_type": "type",
    "address": "123 Main Street",
    "address2": "Apt 1",
    "balance": "0",
    "card_expiry_month": 12,
    "card_expiry_year": 2099,
    "card_number": "4242424242424242",
    "city": "Anytown",
    "company": "Company",
    "country": "Anycountry",
    "created_on": "2014-03-01T12:21:59.3456Z",
    "edited_on": "2014-03-01T12:21:59.3456Z",
    "enterprise_billing_email": "johndoe@gmail.com",
    "enterprise_primary_email": "johndoe@gmail.com",
    "first_name": "John",
    "is_partner": false,
    "last_name": "Doe",
    "next_bill_date": "2014-03-01T12:21:59.3456Z",
    "payment_address": "123 Main Street",
    "payment_address2": "Apt 1",
    "payment_city": "Anytown",
    "payment_country": "Anycountry",
    "payment_email": "johndoe@gmail.com",
    "payment_first_name": "John",
    "payment_last_name": "Doe",
    "payment_state": "state",
    "payment_zipcode": "12345",
    "primary_email": "johndoe@gmail.com",
    "state": "AnyState",
    "tax_id_type": "type",
    "telephone": "1234567899",
    "validation_code": "1111",
    "vat": "GB123456789",
    "zipcode": "12345"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "b69a9f3492637782896352daae219e7d",
    "account_type": "type",
    "address": "123 Main Street",
    "address2": "Apt 1",
    "balance": "0",
    "card_expiry_month": 12,
    "card_expiry_year": 2099,
    "card_number": "4242424242424242",
    "city": "Anytown",
    "company": "Company",
    "country": "Anycountry",
    "created_on": "2014-03-01T12:21:59.3456Z",
    "edited_on": "2014-03-01T12:21:59.3456Z",
    "enterprise_billing_email": "johndoe@gmail.com",
    "enterprise_primary_email": "johndoe@gmail.com",
    "first_name": "John",
    "is_partner": false,
    "last_name": "Doe",
    "next_bill_date": "2014-03-01T12:21:59.3456Z",
    "payment_address": "123 Main Street",
    "payment_address2": "Apt 1",
    "payment_city": "Anytown",
    "payment_country": "Anycountry",
    "payment_email": "johndoe@gmail.com",
    "payment_first_name": "John",
    "payment_last_name": "Doe",
    "payment_state": "state",
    "payment_zipcode": "12345",
    "primary_email": "johndoe@gmail.com",
    "state": "AnyState",
    "tax_id_type": "type",
    "telephone": "1234567899",
    "validation_code": "1111",
    "vat": "GB123456789",
    "zipcode": "12345"
  },
  "success": true
}