Skip to content
Cloudflare API
Start here
API Reference

Accounts

List Accounts
accounts.list(AccountListParams**kwargs) -> SyncV4PagePaginationArray[Account]
GET/accounts
Account Details
accounts.get(AccountGetParams**kwargs) -> Account
GET/accounts/{account_id}
Create an account
accounts.create(AccountCreateParams**kwargs) -> Account
POST/accounts
Update Account
accounts.update(AccountUpdateParams**kwargs) -> Account
PUT/accounts/{account_id}
Delete a specific account
accounts.delete(AccountDeleteParams**kwargs) -> AccountDeleteResponse
DELETE/accounts/{account_id}
ModelsExpand Collapse
class Account: …
id: str

Identifier

maxLength32
minLength32
name: str

Account name

maxLength100
type: Literal["standard", "enterprise"]
One of the following:
"standard"
"enterprise"
created_on: Optional[datetime]

Timestamp for the creation of the account

formatdate-time
managed_by: Optional[ManagedBy]

Parent container details

parent_org_id: Optional[str]

ID of the parent Organization, if one exists

maxLength32
parent_org_name: Optional[str]

Name of the parent Organization, if one exists

settings: Optional[Settings]

Account settings

abuse_contact_email: Optional[str]

Sets an abuse contact email to notify for abuse reports.

enforce_twofactor: Optional[bool]

Indicates whether membership in this account requires that Two-Factor Authentication is enabled

class AccountDeleteResponse: …
id: str

Identifier

maxLength32
minLength32

AccountsAccount Organizations

AccountsAccount Profile

AccountsMembers

List Members
accounts.members.list(MemberListParams**kwargs) -> SyncV4PagePaginationArray[Member]
GET/accounts/{account_id}/members
Member Details
accounts.members.get(strmember_id, MemberGetParams**kwargs) -> Member
GET/accounts/{account_id}/members/{member_id}
Add Member
accounts.members.create(MemberCreateParams**kwargs) -> Member
POST/accounts/{account_id}/members
Update Member
accounts.members.update(strmember_id, MemberUpdateParams**kwargs) -> Member
PUT/accounts/{account_id}/members/{member_id}
Remove Member
accounts.members.delete(strmember_id, MemberDeleteParams**kwargs) -> MemberDeleteResponse
DELETE/accounts/{account_id}/members/{member_id}
ModelsExpand Collapse
Literal["member", "invited"]

Whether the user is a member of the organization or has an invitation pending.

One of the following:
"member"
"invited"
class MemberDeleteResponse: …
id: str

Identifier

maxLength32
minLength32

AccountsRoles

List Roles
Deprecated
accounts.roles.list(RoleListParams**kwargs) -> SyncV4PagePaginationArray[Role]
GET/accounts/{account_id}/roles
Role Details
Deprecated
accounts.roles.get(strrole_id, RoleGetParams**kwargs) -> Role
GET/accounts/{account_id}/roles/{role_id}

AccountsSubscriptions

List Subscriptions
accounts.subscriptions.get(SubscriptionGetParams**kwargs) -> SyncSinglePage[Subscription]
GET/{accounts_or_zones}/{account_or_zone_id}/subscriptions
Get Subscription
accounts.subscriptions.get_by_identifier(strsubscription_identifier, SubscriptionGetByIdentifierParams**kwargs) -> Subscription
GET/accounts/{account_id}/subscriptions/{subscription_identifier}
Create Subscription
accounts.subscriptions.create(SubscriptionCreateParams**kwargs) -> Subscription
POST/{accounts_or_zones}/{account_or_zone_id}/subscriptions
Update Subscription
accounts.subscriptions.update(strsubscription_identifier, SubscriptionUpdateParams**kwargs) -> Subscription
PUT/accounts/{account_id}/subscriptions/{subscription_identifier}
Delete Subscription
accounts.subscriptions.delete(strsubscription_identifier, SubscriptionDeleteParams**kwargs) -> SubscriptionDeleteResponse
DELETE/accounts/{account_id}/subscriptions/{subscription_identifier}
Cancel Delayed Downgrade
accounts.subscriptions.cancel_downgrade(SubscriptionCancelDowngradeParams**kwargs) -> SubscriptionCancelDowngradeResponse
POST/accounts/{account_id}/subscriptions/cancel-downgrade
ModelsExpand Collapse
class SubscriptionDeleteResponse: …
subscription_id: Optional[str]

Subscription identifier tag.

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

AccountsSubscriptionsCancel Reason

Create Cancel Reason
accounts.subscriptions.cancel_reason.create(strsubscription_identifier, CancelReasonCreateParams**kwargs) -> CancelReasonCreateResponse
POST/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason
Get Cancel Reason
accounts.subscriptions.cancel_reason.get(strsubscription_identifier, CancelReasonGetParams**kwargs) -> CancelReasonGetResponse
GET/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason
ModelsExpand Collapse
class CancelReasonCreateResponse: …
id: Optional[str]

The cancel reason identifier.

other: Optional[str]

Additional cancellation details.

reason_code: Optional[List[str]]

The cancellation reason codes.

submitted: Optional[datetime]

When the cancel reason was submitted.

formatdate-time
subscription_id: Optional[str]

The subscription identifier.

class CancelReasonGetResponse: …
id: Optional[str]

The cancel reason identifier.

other: Optional[str]

Additional cancellation details.

reason_code: Optional[List[str]]

The cancellation reason codes.

submitted: Optional[datetime]

When the cancel reason was submitted.

formatdate-time
subscription_id: Optional[str]

The subscription identifier.

AccountsSubscriptionsActions

Append Subscription Action
accounts.subscriptions.actions.append(strsubscription_identifier, ActionAppendParams**kwargs) -> Subscription
POST/accounts/{account_id}/subscriptions/{subscription_identifier}/action/append

AccountsSubscriptionsBulk

Create Subscriptions
accounts.subscriptions.bulk.create(BulkCreateParams**kwargs) -> BulkCreateResponse
POST/accounts/{account_id}/bulk/subscriptions
ModelsExpand Collapse
Optional[List[object]]

AccountsTokens

List Tokens
accounts.tokens.list(TokenListParams**kwargs) -> SyncV4PagePaginationArray[Token]
GET/accounts/{account_id}/tokens
Token Details
accounts.tokens.get(strtoken_id, TokenGetParams**kwargs) -> Token
GET/accounts/{account_id}/tokens/{token_id}
Create Token
accounts.tokens.create(TokenCreateParams**kwargs) -> TokenCreateResponse
POST/accounts/{account_id}/tokens
Update Token
accounts.tokens.update(strtoken_id, TokenUpdateParams**kwargs) -> Token
PUT/accounts/{account_id}/tokens/{token_id}
Delete Token
accounts.tokens.delete(strtoken_id, TokenDeleteParams**kwargs) -> TokenDeleteResponse
DELETE/accounts/{account_id}/tokens/{token_id}
Verify Token
accounts.tokens.verify(TokenVerifyParams**kwargs) -> TokenVerifyResponse
GET/accounts/{account_id}/tokens/verify
ModelsExpand Collapse
class TokenCreateResponse: …
id: Optional[str]

Token identifier tag.

maxLength32
condition: Optional[Condition]
request_ip: Optional[ConditionRequestIP]

Client IP restrictions.

in_: Optional[List[TokenConditionCIDRList]]

List of IPv4/IPv6 CIDR addresses.

not_in: Optional[List[TokenConditionCIDRList]]

List of IPv4/IPv6 CIDR addresses.

expires_on: Optional[datetime]

The expiration time on or after which the JWT MUST NOT be accepted for processing.

formatdate-time
issued_on: Optional[datetime]

The time on which the token was created.

formatdate-time
last_used_on: Optional[datetime]

Last time the token was used.

formatdate-time
modified_on: Optional[datetime]

Last time the token was modified.

formatdate-time
name: Optional[str]

Token name.

maxLength120
not_before: Optional[datetime]

The time before which the token MUST NOT be accepted for processing.

formatdate-time
policies: Optional[List[TokenPolicy]]

List of access policies assigned to the token.

id: str

Policy identifier.

effect: Literal["allow", "deny"]

Allow or deny operations against the resources.

One of the following:
"allow"
"deny"
permission_groups: List[PermissionGroup]

A set of permission groups that are specified to the policy.

id: str

Identifier of the permission group.

meta: Optional[PermissionGroupMeta]

Attributes associated to the permission group.

key: Optional[str]
value: Optional[str]
name: Optional[str]

Name of the permission group.

resources: Union[Dict[str, str], Dict[str, Dict[str, str]]]

A list of resource names that the policy applies to.

One of the following:
Dict[str, str]

Map of simple string resource permissions

Dict[str, Dict[str, str]]

Map of nested resource permissions

status: Optional[Literal["active", "disabled", "expired"]]

Status of the token.

One of the following:
"active"
"disabled"
"expired"
value: Optional[TokenValue]

The token value.

maxLength80
minLength40
class TokenDeleteResponse: …
id: str

Identifier

maxLength32
minLength32
class TokenVerifyResponse: …
id: str

Token identifier tag.

maxLength32
status: Literal["active", "disabled", "expired"]

Status of the token.

One of the following:
"active"
"disabled"
"expired"
expires_on: Optional[datetime]

The expiration time on or after which the JWT MUST NOT be accepted for processing.

formatdate-time
not_before: Optional[datetime]

The time before which the token MUST NOT be accepted for processing.

formatdate-time

AccountsTokensPermission Groups

List Permission Groups
accounts.tokens.permission_groups.list(PermissionGroupListParams**kwargs) -> SyncSinglePage[PermissionGroupListResponse]
GET/accounts/{account_id}/tokens/permission_groups
List Permission Groups
accounts.tokens.permission_groups.get(PermissionGroupGetParams**kwargs) -> PermissionGroupGetResponse
GET/accounts/{account_id}/tokens/permission_groups
ModelsExpand Collapse
class PermissionGroupListResponse: …
id: Optional[str]

Public ID.

category: Optional[Literal["developer_platform", "ai_and_machine_learning", "dns_and_zones", 10 more]]

Product category that this permission group belongs to.

One of the following:
"developer_platform"
"ai_and_machine_learning"
"dns_and_zones"
"app_security"
"rules_and_configuration"
"cloudflare_one_and_zero_trust"
"analytics_and_logs"
"network_services"
"media"
"email_and_messaging"
"cache_and_performance"
"account_and_billing"
"other"
name: Optional[str]

Permission Group Name

scopes: Optional[List[Literal["com.cloudflare.api.account", "com.cloudflare.api.account.zone", "com.cloudflare.api.user", "com.cloudflare.edge.r2.bucket"]]]

Resources to which the Permission Group is scoped

One of the following:
"com.cloudflare.api.account"
"com.cloudflare.api.account.zone"
"com.cloudflare.api.user"
"com.cloudflare.edge.r2.bucket"
List[PermissionGroupGetResponseItem]
id: Optional[str]

Public ID.

category: Optional[Literal["developer_platform", "ai_and_machine_learning", "dns_and_zones", 10 more]]

Product category that this permission group belongs to.

One of the following:
"developer_platform"
"ai_and_machine_learning"
"dns_and_zones"
"app_security"
"rules_and_configuration"
"cloudflare_one_and_zero_trust"
"analytics_and_logs"
"network_services"
"media"
"email_and_messaging"
"cache_and_performance"
"account_and_billing"
"other"
name: Optional[str]

Permission Group Name

scopes: Optional[List[Literal["com.cloudflare.api.account", "com.cloudflare.api.account.zone", "com.cloudflare.api.user", "com.cloudflare.edge.r2.bucket"]]]

Resources to which the Permission Group is scoped

One of the following:
"com.cloudflare.api.account"
"com.cloudflare.api.account.zone"
"com.cloudflare.api.user"
"com.cloudflare.edge.r2.bucket"

AccountsTokensValue

Roll Token
accounts.tokens.value.update(strtoken_id, ValueUpdateParams**kwargs) -> TokenValue
PUT/accounts/{account_id}/tokens/{token_id}/value

AccountsLogs

AccountsLogsAudit

Get account audit logs (Version 2)
accounts.logs.audit.list(AuditListParams**kwargs) -> SyncCursorPaginationAfter[AuditListResponse]
GET/accounts/{account_id}/logs/audit
Get resource change history from an account audit log entry (Version 2)
accounts.logs.audit.history(strid, AuditHistoryParams**kwargs) -> AuditHistoryResponse
GET/accounts/{account_id}/logs/audit/{id}/history
List account audit log product categories (Version 2)
accounts.logs.audit.product_categories(AuditProductCategoriesParams**kwargs) -> SyncSinglePage[AuditProductCategoriesResponse]
GET/accounts/{account_id}/logs/audit/product_categories
ModelsExpand Collapse
class AuditListResponse: …
id: Optional[str]

A unique identifier for the audit log entry.

maxLength32
account: Optional[Account]

Contains account related information.

id: Optional[str]

A unique identifier for the account.

name: Optional[str]

A string that identifies the account name.

action: Optional[Action]

Provides information about the action performed.

description: Optional[str]

A short description of the action performed.

result: Optional[str]

The result of the action, indicating success or failure.

time: Optional[datetime]

A timestamp indicating when the action was logged.

formatdate-time
type: Optional[str]

A short string that describes the action that was performed.

actor: Optional[Actor]

Provides details about the actor who performed the action.

id: Optional[str]

The ID of the actor who performed the action. If a user performed the action, this will be their User ID.

context: Optional[Literal["api", "api_key", "api_token", 3 more]]

The context in which the action was initiated.

  • api: The action was performed through the API. The specific credential type was not recorded.
  • api_key: The action was authenticated with a Cloudflare Global API Key.
  • api_token: The action was authenticated with an API token.
  • dash: The action was performed through the Cloudflare dashboard.
  • oauth: The action was authenticated with an OAuth token.
  • origin_ca_key: The action was authenticated with an Origin CA key.
One of the following:
"api"
"api_key"
"api_token"
"dash"
"oauth"
"origin_ca_key"
email: Optional[str]

The email of the actor who performed the action.

formatemail
ip_address: Optional[str]

The IP address of the request that performed the action.

token_id: Optional[str]

The API token ID when the actor context is an api_token or oauth.

token_name: Optional[str]

The API token name when the actor context is an api_token or oauth.

type: Optional[Literal["account", "cloudflare_admin", "delegated_service", 2 more]]

The type of actor.

One of the following:
"account"
"cloudflare_admin"
"delegated_service"
"system"
"user"
raw: Optional[Raw]

Provides raw information about the request and response.

cf_rayid: Optional[str]

The Cloudflare Ray ID for the request.

method: Optional[str]

The HTTP method of the request.

status_code: Optional[int]

The HTTP response status code returned by the API.

uri: Optional[str]

The URI of the request.

user_agent: Optional[str]

The client’s user agent string sent with the request.

resource: Optional[Resource]

Provides details about the affected resource.

id: Optional[str]

The unique identifier for the affected resource.

product: Optional[str]

The Cloudflare product associated with the resource.

request: Optional[object]
response: Optional[object]
scope: Optional[object]

The scope of the resource.

type: Optional[str]

The type of the resource.

zone: Optional[Zone]

Provides details about the zone affected by the action.

id: Optional[str]

A string that identifies the zone id.

name: Optional[str]

A string that identifies the zone name.

List[AuditHistoryResponseItem]
id: Optional[str]

A unique identifier for the audit log entry.

maxLength32
account: Optional[AuditHistoryResponseItemAccount]

Contains account related information.

id: Optional[str]

A unique identifier for the account.

name: Optional[str]

A string that identifies the account name.

action: Optional[AuditHistoryResponseItemAction]

Provides information about the action performed.

description: Optional[str]

A short description of the action performed.

result: Optional[str]

The result of the action, indicating success or failure.

time: Optional[datetime]

A timestamp indicating when the action was logged.

formatdate-time
type: Optional[str]

A short string that describes the action that was performed.

actor: Optional[AuditHistoryResponseItemActor]

Provides details about the actor who performed the action.

id: Optional[str]

The ID of the actor who performed the action. If a user performed the action, this will be their User ID.

context: Optional[Literal["api", "api_key", "api_token", 3 more]]

The context in which the action was initiated.

  • api: The action was performed through the API. The specific credential type was not recorded.
  • api_key: The action was authenticated with a Cloudflare Global API Key.
  • api_token: The action was authenticated with an API token.
  • dash: The action was performed through the Cloudflare dashboard.
  • oauth: The action was authenticated with an OAuth token.
  • origin_ca_key: The action was authenticated with an Origin CA key.
One of the following:
"api"
"api_key"
"api_token"
"dash"
"oauth"
"origin_ca_key"
email: Optional[str]

The email of the actor who performed the action.

formatemail
ip_address: Optional[str]

The IP address of the request that performed the action.

token_id: Optional[str]

The API token ID when the actor context is an api_token or oauth.

token_name: Optional[str]

The API token name when the actor context is an api_token or oauth.

type: Optional[Literal["account", "cloudflare_admin", "delegated_service", 2 more]]

The type of actor.

One of the following:
"account"
"cloudflare_admin"
"delegated_service"
"system"
"user"
raw: Optional[AuditHistoryResponseItemRaw]

Provides raw information about the request and response.

cf_rayid: Optional[str]

The Cloudflare Ray ID for the request.

method: Optional[str]

The HTTP method of the request.

status_code: Optional[int]

The HTTP response status code returned by the API.

uri: Optional[str]

The URI of the request.

user_agent: Optional[str]

The client’s user agent string sent with the request.

resource: Optional[AuditHistoryResponseItemResource]

Provides details about the affected resource.

id: Optional[str]

The unique identifier for the affected resource.

product: Optional[str]

The Cloudflare product associated with the resource.

request: Optional[object]
response: Optional[object]
scope: Optional[object]

The scope of the resource.

type: Optional[str]

The type of the resource.

zone: Optional[AuditHistoryResponseItemZone]

Provides details about the zone affected by the action.

id: Optional[str]

A string that identifies the zone id.

name: Optional[str]

A string that identifies the zone name.

class AuditProductCategoriesResponse: …

A predefined product category and the resource products it expands to.

label: Optional[str]

A human-readable label for the product category.

products: Optional[List[Product]]

The resource products that the product category expands to.

label: Optional[str]

A human-readable label for the product.

value: Optional[str]

The resource_product value that the product category expands to.

value: Optional[str]

The product category identifier used with the product_category filter.

AccountsSpeed Settings

AccountsSpeed SettingsTransformations

List Image Resizing configurations for account
accounts.speed_settings.transformations.get(TransformationGetParams**kwargs) -> SyncSinglePage[TransformationsConfig]
GET/accounts/{account_id}/settings/transformations
ModelsExpand Collapse
class TransformationsConfig: …

A configuration item for a specific zone and feature.

id: Optional[str]

Feature identifier.

cf_zone_tag: Optional[str]

Zone tag identifier.

editable: Optional[bool]

Whether this setting can be modified.

modified_on: Optional[datetime]

When this setting was last modified.

formatdate-time
value: Optional[str]

Current value of the feature setting.

AccountsPayment 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]

AccountsPay Invoice

Pay Invoice
accounts.pay_invoice.create(PayInvoiceCreateParams**kwargs) -> PayInvoiceCreateResponse
POST/accounts/{account_id}/pay-invoice
ModelsExpand Collapse
class PayInvoiceCreateResponse: …
client_secret: Optional[str]

The Stripe client secret for frontend payment confirmation.

AccountsPay Bad Debt

Pay Bad Debt
accounts.pay_bad_debt.create(PayBadDebtCreateParams**kwargs) -> PayBadDebtCreateResponse
POST/accounts/{account_id}/pay-bad-debt
ModelsExpand Collapse
class PayBadDebtCreateResponse: …
client_secret: Optional[str]

The Stripe client secret for frontend payment confirmation.

AccountsReceipts

Get Receipt PDF
accounts.receipts.pdf(strreceipt_id, ReceiptPDFParams**kwargs) -> BinaryResponseContent
GET/accounts/{account_id}/receipts/{receipt_id}/pdf

AccountsInvoices

Toggle PDF Invoices
accounts.invoices.edit(InvoiceEditParams**kwargs) -> InvoiceEditResponse
PATCH/accounts/{account_id}/invoices
ModelsExpand Collapse
Union[Optional[str], Optional[object]]
One of the following:
Optional[str]
Optional[object]

AccountsClient Secret

Create Setup Intent
accounts.client_secret.create(ClientSecretCreateParams**kwargs) -> ClientSecretCreateResponse
POST/accounts/{account_id}/client-secret
ModelsExpand Collapse
class ClientSecretCreateResponse: …
client_secret: Optional[str]

The Stripe client secret for frontend payment confirmation.