Create Billing Profile

client.Billing.Profiles.New(ctx, params) (*ProfileNewResponse, error)

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

ParametersExpand Collapse

params ProfileNewParams

AccountID param.Field[string]

Path param: Identifier

maxLength32

Address param.Field[string]Optional

Body param: Street address line 1.

Address2 param.Field[string]Optional

Body param: Street address line 2 (apt, suite, etc.).

BillingEmail param.Field[string]Optional

Body param: Primary billing email address.

BuyingRatePlan param.Field[string]Optional

Body param: Rate plan being purchased right after profile setup.

CaptchaChallengeJWT param.Field[string]Optional

Body param: Captcha challenge JWT issued during onboarding.

CfTurnstileResponse param.Field[string]Optional

Body param: Cloudflare Turnstile response.

City param.Field[string]Optional

Body param: City on the billing profile.

Company param.Field[string]Optional

Body param: Company name on the billing profile.

Country param.Field[string]Optional

Body param: ISO 3166-1 alpha-2 country code.

FirstName param.Field[string]Optional

Body param: First name on the billing profile.

HCaptchaResponse param.Field[string]Optional

Body param: hCaptcha response.

LastName param.Field[string]Optional

Body param: Last name on the billing profile.

PreferredLocale param.Field[string]Optional

Body param: Preferred locale for invoice rendering (BCP 47).

SecondaryBillingEmail param.Field[string]Optional

Body param: Secondary billing email address for CC on invoices.

State param.Field[string]Optional

Body param: State or region on the billing profile.

TaxIDType param.Field[string]Optional

Body param: Type of tax ID provided.

Telephone param.Field[string]Optional

Body param: Contact phone number.

Vat param.Field[string]Optional

Body param: VAT identifier.

Zipcode param.Field[string]Optional

Body param: ZIP or postal code.

ReturnsExpand Collapse

type ProfileNewResponse struct{…}

ID stringOptional

Billing item identifier tag.

maxLength32

AccountType stringOptional

Address stringOptional

Address2 stringOptional

Balance stringOptional

CardExpiryMonth int64Optional

CardExpiryYear int64Optional

CardNumber stringOptional

City stringOptional

Company stringOptional

Country stringOptional

CreatedOn TimeOptional

formatdate-time

DeviceData stringOptional

EditedOn TimeOptional

formatdate-time

EnterpriseBillingEmail stringOptional

EnterprisePrimaryEmail stringOptional

FirstName stringOptional

IsPartner boolOptional

LastName stringOptional

NextBillDate TimeOptional

formatdate-time

PaymentAddress stringOptional

PaymentAddress2 stringOptional

PaymentCity stringOptional

PaymentCountry stringOptional

PaymentEmail stringOptional

PaymentFirstName stringOptional

PaymentGateway stringOptional

PaymentLastName stringOptional

PaymentNonce stringOptional

PaymentState stringOptional

PaymentZipcode stringOptional

PrimaryEmail stringOptional

State stringOptional

TaxIDType stringOptional

Telephone stringOptional

ValidationCode stringOptional

Vat stringOptional

Zipcode stringOptional

Create Billing Profile

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"),
  )
  profile, err := client.Billing.Profiles.New(context.TODO(), billing.ProfileNewParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", profile.ID)
}

{
  "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
}