Skip to content
Cloudflare API
Start here
API Reference
Accounts
Payment Methods

Create Payment Method

accounts.payment_methods.create(PaymentMethodCreateParams**kwargs) -> PaymentMethodCreateResponse
POST/accounts/{account_id}/payment-methods

Creates a new payment method 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
account_id: str

Identifier

maxLength32
address: Optional[str]

Billing address line 1.

address2: Optional[str]

Billing address line 2.

bank_account_type: Optional[str]

Bank account type.

bank_code: Optional[str]

Bank code.

bank_country: Optional[str]

Bank country.

bank_name: Optional[str]

Bank name for bank-based payment methods.

bank_routing_number: Optional[str]

Bank routing number.

cashapp_cash_tag: Optional[str]

Cash App cash tag.

city: Optional[str]

Billing city.

country: Optional[str]

Billing country.

default: Optional[bool]

Whether this is the default payment method.

device_data: Optional[str]

Device data for fraud prevention.

first_name: Optional[str]

Billing first name.

last_name: Optional[str]

Billing last name.

nick_name: Optional[str]

A nickname for the payment method.

payment_account_email: Optional[str]

Email associated with the payment account.

payment_email: Optional[str]

Payment email address.

payment_gateway: Optional[str]

The payment gateway used.

payment_nonce: Optional[str]

Payment nonce for tokenized payments.

state: Optional[str]

Billing state.

type: Optional[Literal["CREDIT_CARD", "PAYPAL", "CASHAPP", 3 more]]

The payment method type.

One of the following:
"CREDIT_CARD"
"PAYPAL"
"CASHAPP"
"SEPA_DEBIT"
"LINK"
"ACH_DIRECT_DEBIT"
zipcode: Optional[str]

Billing zip code.

ReturnsExpand Collapse
class PaymentMethodCreateResponse: …
id: Optional[str]

Payment method identifier.

address: Optional[str]

Billing address line 1.

address2: Optional[str]

Billing address line 2.

bank_account_type: Optional[str]

Bank account type.

bank_code: Optional[str]

Bank code.

bank_country: Optional[str]

Bank country.

bank_name: Optional[str]

Bank name for bank-based payment methods.

bank_routing_number: Optional[str]

Bank routing number.

cashapp_cash_tag: Optional[str]

Cash App cash tag.

city: Optional[str]

Billing city.

country: Optional[str]

Billing country.

default: Optional[bool]

Whether this is the default payment method.

device_data: Optional[str]

Device data for fraud prevention.

expiration_date: Optional[str]

Card expiration date.

first_name: Optional[str]

Billing first name.

last_four: Optional[str]

Last four digits of the card number.

last_name: Optional[str]

Billing last name.

nick_name: Optional[str]

A nickname for the payment method.

payment_account_email: Optional[str]

Email associated with the payment account.

payment_email: Optional[str]

Payment email address.

payment_gateway: Optional[str]

The payment gateway used.

payment_nonce: Optional[str]

Payment nonce for tokenized payments.

state: Optional[str]

Billing state.

type: Optional[Literal["CREDIT_CARD", "PAYPAL", "CASHAPP", 3 more]]

The payment method type.

One of the following:
"CREDIT_CARD"
"PAYPAL"
"CASHAPP"
"SEPA_DEBIT"
"LINK"
"ACH_DIRECT_DEBIT"
zipcode: Optional[str]

Billing zip code.

Create Payment Method

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
payment_method = client.accounts.payment_methods.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(payment_method.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": "id",
    "address": "address",
    "address2": "address2",
    "bank_account_type": "bank_account_type",
    "bank_code": "bank_code",
    "bank_country": "bank_country",
    "bank_name": "bank_name",
    "bank_routing_number": "bank_routing_number",
    "cashapp_cash_tag": "cashapp_cash_tag",
    "city": "city",
    "country": "country",
    "default": true,
    "expiration_date": "expiration_date",
    "first_name": "first_name",
    "last_four": "4242",
    "last_name": "last_name",
    "nick_name": "nick_name",
    "payment_account_email": "payment_account_email",
    "payment_email": "payment_email",
    "state": "state",
    "type": "CREDIT_CARD",
    "zipcode": "zipcode"
  },
  "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": "id",
    "address": "address",
    "address2": "address2",
    "bank_account_type": "bank_account_type",
    "bank_code": "bank_code",
    "bank_country": "bank_country",
    "bank_name": "bank_name",
    "bank_routing_number": "bank_routing_number",
    "cashapp_cash_tag": "cashapp_cash_tag",
    "city": "city",
    "country": "country",
    "default": true,
    "expiration_date": "expiration_date",
    "first_name": "first_name",
    "last_four": "4242",
    "last_name": "last_name",
    "nick_name": "nick_name",
    "payment_account_email": "payment_account_email",
    "payment_email": "payment_email",
    "state": "state",
    "type": "CREDIT_CARD",
    "zipcode": "zipcode"
  },
  "success": true
}