Skip to content
Cloudflare API
Start here
API Reference
Accounts

Payment Methods

List Payment Methods
accounts.payment_methods.list(PaymentMethodListParams**kwargs) -> SyncV4PagePaginationArray[PaymentMethodListResponse]
GET/accounts/{account_id}/payment-methods
Create Payment Method
accounts.payment_methods.create(PaymentMethodCreateParams**kwargs) -> PaymentMethodCreateResponse
POST/accounts/{account_id}/payment-methods
Get Payment Method
accounts.payment_methods.get(strpayment_method_id, PaymentMethodGetParams**kwargs) -> PaymentMethodGetResponse
GET/accounts/{account_id}/payment-methods/{payment_method_id}
Update Payment Method
accounts.payment_methods.update(strpayment_method_id, PaymentMethodUpdateParams**kwargs) -> PaymentMethodUpdateResponse
PUT/accounts/{account_id}/payment-methods/{payment_method_id}
Delete Payment Method
accounts.payment_methods.delete(strpayment_method_id, PaymentMethodDeleteParams**kwargs) -> PaymentMethodDeleteResponse
DELETE/accounts/{account_id}/payment-methods/{payment_method_id}
Set Default Payment Method
accounts.payment_methods.set_as_default(strpayment_method_id, PaymentMethodSetAsDefaultParams**kwargs) -> PaymentMethodSetAsDefaultResponse
POST/accounts/{account_id}/payment-methods/{payment_method_id}/set-as-default
ModelsExpand Collapse
class PaymentMethodListResponse: …
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.

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.

class PaymentMethodGetResponse: …
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.

class PaymentMethodUpdateResponse: …
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.

Union[Optional[str], Optional[object]]
One of the following:
Optional[str]
Optional[object]
Union[Optional[str], Optional[object]]
One of the following:
Optional[str]
Optional[object]