--- title: Accounts --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Accounts ##### [List Accounts](https://developers.cloudflare.com/api/python/resources/accounts/methods/list) accounts.list(AccountListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Account]()] GET/accounts ##### [Account Details](https://developers.cloudflare.com/api/python/resources/accounts/methods/get) accounts.get(AccountGetParams\*\*kwargs) -> [Account]() GET/accounts/{account\_id} ##### [Create an Account](https://developers.cloudflare.com/api/python/resources/accounts/methods/create) accounts.create(AccountCreateParams\*\*kwargs) -> [Account]() POST/accounts ##### [Update Account](https://developers.cloudflare.com/api/python/resources/accounts/methods/update) accounts.update(AccountUpdateParams\*\*kwargs) -> [Account]() PUT/accounts/{account\_id} ##### [Delete a specific account](https://developers.cloudflare.com/api/python/resources/accounts/methods/delete) accounts.delete(AccountDeleteParams\*\*kwargs) -> [AccountDeleteResponse]() DELETE/accounts/{account\_id} ##### ModelsExpand Collapse
class Account: … id: str Identifier maxLength32 minLength32 Link to this property name: str Account name maxLength100 Link to this property
type: Literal\["standard", "enterprise"] One of the following: "standard" Link to this property "enterprise" Link to this property
Link to this property created\_on: Optional\[datetime] Timestamp for the creation of the account formatdate-time Link to this property
managed\_by: Optional\[ManagedBy] Parent container details parent\_org\_id: Optional\[str] ID of the parent Organization, if one exists maxLength32 Link to this property parent\_org\_name: Optional\[str] Name of the parent Organization, if one exists Link to this property
Link to this property
settings: Optional\[Settings] Account settings abuse\_contact\_email: Optional\[str] Sets an abuse contact email to notify for abuse reports. Link to this property enforce\_twofactor: Optional\[bool] Indicates whether membership in this account requires that Two-Factor Authentication is enabled Link to this property
Link to this property
[Link to this property](<#(resource)%20accounts%20%3E%20(model)%20account%20%3E%20(schema)>)
class AccountDeleteResponse: … id: str Identifier maxLength32 minLength32 Link to this property
[Link to this property](<#(resource)%20accounts%20%3E%20(model)%20account_delete_response%20%3E%20(schema)>) #### AccountsAccount Organizations #### AccountsAccount Profile #### AccountsMembers ##### [List Members](https://developers.cloudflare.com/api/python/resources/accounts/subresources/members/methods/list) accounts.members.list(MemberListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Member]()] GET/accounts/{account\_id}/members ##### [Member Details](https://developers.cloudflare.com/api/python/resources/accounts/subresources/members/methods/get) accounts.members.get(strmember\_id, MemberGetParams\*\*kwargs) -> [Member]() GET/accounts/{account\_id}/members/{member\_id} ##### [Add Member](https://developers.cloudflare.com/api/python/resources/accounts/subresources/members/methods/create) accounts.members.create(MemberCreateParams\*\*kwargs) -> [Member]() POST/accounts/{account\_id}/members ##### [Update Member](https://developers.cloudflare.com/api/python/resources/accounts/subresources/members/methods/update) accounts.members.update(strmember\_id, MemberUpdateParams\*\*kwargs) -> [Member]() PUT/accounts/{account\_id}/members/{member\_id} ##### [Remove Member](https://developers.cloudflare.com/api/python/resources/accounts/subresources/members/methods/delete) 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" Link to this property "invited" Link to this property
[Link to this property](<#(resource)%20accounts.members%20%3E%20(model)%20status%20%3E%20(schema)>)
class MemberDeleteResponse: … id: str Identifier maxLength32 minLength32 Link to this property
[Link to this property](<#(resource)%20accounts.members%20%3E%20(model)%20member_delete_response%20%3E%20(schema)>) #### AccountsRoles ##### [List Roles](https://developers.cloudflare.com/api/python/resources/accounts/subresources/roles/methods/list) Deprecated accounts.roles.list(RoleListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Role]()] GET/accounts/{account\_id}/roles ##### [Role Details](https://developers.cloudflare.com/api/python/resources/accounts/subresources/roles/methods/get) Deprecated accounts.roles.get(strrole\_id, RoleGetParams\*\*kwargs) -> [Role]() GET/accounts/{account\_id}/roles/{role\_id} #### AccountsSubscriptions ##### [List Subscriptions](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/methods/get) accounts.subscriptions.get(SubscriptionGetParams\*\*kwargs) -> SyncSinglePage\[[Subscription]()] GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/subscriptions ##### [Get Subscription](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/methods/get_by_identifier) accounts.subscriptions.get\_by\_identifier(strsubscription\_identifier, SubscriptionGetByIdentifierParams\*\*kwargs) -> [Subscription]() GET/accounts/{account\_id}/subscriptions/{subscription\_identifier} ##### [Create Subscription](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/methods/create) accounts.subscriptions.create(SubscriptionCreateParams\*\*kwargs) -> [Subscription]() POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/subscriptions ##### [Update Subscription](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/methods/update) accounts.subscriptions.update(strsubscription\_identifier, SubscriptionUpdateParams\*\*kwargs) -> [Subscription]() PUT/accounts/{account\_id}/subscriptions/{subscription\_identifier} ##### [Delete Subscription](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/methods/delete) accounts.subscriptions.delete(strsubscription\_identifier, SubscriptionDeleteParams\*\*kwargs) -> [SubscriptionDeleteResponse]() DELETE/accounts/{account\_id}/subscriptions/{subscription\_identifier} ##### [Cancel Delayed Downgrade](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/methods/cancel_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 Link to this property
[Link to this property](<#(resource)%20accounts.subscriptions%20%3E%20(model)%20subscription_delete_response%20%3E%20(schema)>)
Union\[Optional\[str], Optional\[object]] One of the following: Optional\[str] Link to this property Optional\[object] Link to this property
[Link to this property](<#(resource)%20accounts.subscriptions%20%3E%20(model)%20subscription_cancel_downgrade_response%20%3E%20(schema)>) #### AccountsSubscriptionsCancel Reason ##### [Create Cancel Reason](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/subresources/cancel_reason/methods/create) accounts.subscriptions.cancel\_reason.create(strsubscription\_identifier, CancelReasonCreateParams\*\*kwargs) -> [CancelReasonCreateResponse]() POST/accounts/{account\_id}/subscriptions/{subscription\_identifier}/cancel-reason ##### [Get Cancel Reason](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/subresources/cancel_reason/methods/get) 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. Link to this property other: Optional\[str] Additional cancellation details. Link to this property reason\_code: Optional\[List\[str]] The cancellation reason codes. Link to this property submitted: Optional\[datetime] When the cancel reason was submitted. formatdate-time Link to this property subscription\_id: Optional\[str] The subscription identifier. Link to this property
[Link to this property](<#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_create_response%20%3E%20(schema)>)
class CancelReasonGetResponse: … id: Optional\[str] The cancel reason identifier. Link to this property other: Optional\[str] Additional cancellation details. Link to this property reason\_code: Optional\[List\[str]] The cancellation reason codes. Link to this property submitted: Optional\[datetime] When the cancel reason was submitted. formatdate-time Link to this property subscription\_id: Optional\[str] The subscription identifier. Link to this property
[Link to this property](<#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_get_response%20%3E%20(schema)>) #### AccountsSubscriptionsActions ##### [Append Subscription Action](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/subresources/actions/methods/append) accounts.subscriptions.actions.append(strsubscription\_identifier, ActionAppendParams\*\*kwargs) -> [Subscription]() POST/accounts/{account\_id}/subscriptions/{subscription\_identifier}/action/append #### AccountsSubscriptionsBulk ##### [Create Subscriptions](https://developers.cloudflare.com/api/python/resources/accounts/subresources/subscriptions/subresources/bulk/methods/create) accounts.subscriptions.bulk.create(BulkCreateParams\*\*kwargs) -> [BulkCreateResponse]() POST/accounts/{account\_id}/bulk/subscriptions ##### ModelsExpand Collapse Optional\[List\[object]] [Link to this property](<#(resource)%20accounts.subscriptions.bulk%20%3E%20(model)%20bulk_create_response%20%3E%20(schema)>) #### AccountsTokens ##### [List Tokens](https://developers.cloudflare.com/api/python/resources/accounts/subresources/tokens/methods/list) accounts.tokens.list(TokenListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Token]()] GET/accounts/{account\_id}/tokens ##### [Token Details](https://developers.cloudflare.com/api/python/resources/accounts/subresources/tokens/methods/get) accounts.tokens.get(strtoken\_id, TokenGetParams\*\*kwargs) -> [Token]() GET/accounts/{account\_id}/tokens/{token\_id} ##### [Create Token](https://developers.cloudflare.com/api/python/resources/accounts/subresources/tokens/methods/create) accounts.tokens.create(TokenCreateParams\*\*kwargs) -> [TokenCreateResponse]() POST/accounts/{account\_id}/tokens ##### [Update Token](https://developers.cloudflare.com/api/python/resources/accounts/subresources/tokens/methods/update) accounts.tokens.update(strtoken\_id, TokenUpdateParams\*\*kwargs) -> [Token]() PUT/accounts/{account\_id}/tokens/{token\_id} ##### [Delete Token](https://developers.cloudflare.com/api/python/resources/accounts/subresources/tokens/methods/delete) accounts.tokens.delete(strtoken\_id, TokenDeleteParams\*\*kwargs) -> [TokenDeleteResponse]() DELETE/accounts/{account\_id}/tokens/{token\_id} ##### [Verify Token](https://developers.cloudflare.com/api/python/resources/accounts/subresources/tokens/methods/verify) accounts.tokens.verify(TokenVerifyParams\*\*kwargs) -> [TokenVerifyResponse]() GET/accounts/{account\_id}/tokens/verify ##### ModelsExpand Collapse
class TokenCreateResponse: … id: Optional\[str] Token identifier tag. maxLength32 Link to this property
condition: Optional\[Condition]
request\_ip: Optional\[ConditionRequestIP] Client IP restrictions. in\_: Optional\[List\[TokenConditionCIDRList]] List of IPv4/IPv6 CIDR addresses. Link to this property not\_in: Optional\[List\[TokenConditionCIDRList]] List of IPv4/IPv6 CIDR addresses. Link to this property
Link to this property
Link to this property creator\_email\_at\_creation: Optional\[str] The email address of the user who created the token at the time of creation. Only present for Account Owned API Tokens when a creator email was available. maxLength90 Link to this property expires\_on: Optional\[datetime] The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property issued\_on: Optional\[datetime] The time on which the token was created. formatdate-time Link to this property last\_used\_on: Optional\[datetime] Last time the token was used. formatdate-time Link to this property modified\_on: Optional\[datetime] Last time the token was modified. formatdate-time Link to this property name: Optional\[str] Token name. maxLength120 Link to this property not\_before: Optional\[datetime] The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property
policies: Optional\[List\[TokenPolicy]] List of access policies assigned to the token. id: str Policy identifier. Link to this property
effect: Literal\["allow", "deny"] Allow or deny operations against the resources. One of the following: "allow" Link to this property "deny" Link to this property
Link to this property
permission\_groups: List\[PermissionGroup] A set of permission groups that are specified to the policy. id: str Identifier of the permission group. Link to this property
meta: Optional\[PermissionGroupMeta] Attributes associated to the permission group. category: Optional\[str] A category used to group permission groups. Link to this property deprecated: Optional\[str] Indicates whether the permission group is deprecated. Link to this property description: Optional\[str] Additional information about the permission group. Link to this property editable: Optional\[str] Indicates whether the permission group can be edited. Link to this property eol\_at: Optional\[datetime] The planned end-of-life date and time, when provided. formatdate-time Link to this property label: Optional\[str] A label identifying the permission group. Link to this property scopes: Optional\[str] The scope associated with the permission group. Link to this property visibility: Optional\[str] Indicates the permission group’s availability or visibility. Link to this property
Link to this property name: Optional\[str] Name of the permission group. Link to this property
Link to this property
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 Link to this property Dict\[str, Dict\[str, str]] Map of nested resource permissions Link to this property
Link to this property
Link to this property provisioner\_id: Optional\[str] The identifier of the service that provisioned the token. For an OAuth-provisioned token, this is the OAuth client identifier. Present when provisioner_type is present and null when the identifier is unavailable. Link to this property provisioner\_type: Optional\[str] The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens. Link to this property
status: Optional\[Literal\["active", "disabled", "expired"]] Status of the token. One of the following: "active" Link to this property "disabled" Link to this property "expired" Link to this property
Link to this property value: Optional\[TokenValue] The token value. maxLength80 minLength40 Link to this property
[Link to this property](<#(resource)%20accounts.tokens%20%3E%20(model)%20token_create_response%20%3E%20(schema)>)
class TokenDeleteResponse: … id: str Identifier maxLength32 minLength32 Link to this property
[Link to this property](<#(resource)%20accounts.tokens%20%3E%20(model)%20token_delete_response%20%3E%20(schema)>)
class TokenVerifyResponse: … id: str Token identifier tag. maxLength32 Link to this property
status: Literal\["active", "disabled", "expired"] Status of the token. One of the following: "active" Link to this property "disabled" Link to this property "expired" Link to this property
Link to this property expires\_on: Optional\[datetime] The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property not\_before: Optional\[datetime] The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property
[Link to this property](<#(resource)%20accounts.tokens%20%3E%20(model)%20token_verify_response%20%3E%20(schema)>) #### AccountsTokensPermission Groups ##### [List Permission Groups](https://developers.cloudflare.com/api/python/resources/accounts/subresources/tokens/subresources/permission_groups/methods/list) accounts.tokens.permission\_groups.list(PermissionGroupListParams\*\*kwargs) -> SyncSinglePage\[[PermissionGroupListResponse]()] GET/accounts/{account\_id}/tokens/permission\_groups ##### [List Permission Groups](https://developers.cloudflare.com/api/python/resources/accounts/subresources/tokens/subresources/permission_groups/methods/get) accounts.tokens.permission\_groups.get(PermissionGroupGetParams\*\*kwargs) -> [PermissionGroupGetResponse]() GET/accounts/{account\_id}/tokens/permission\_groups ##### ModelsExpand Collapse
class PermissionGroupListResponse: … id: Optional\[str] Public ID. Link to this property
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" Link to this property "ai\_and\_machine\_learning" Link to this property "dns\_and\_zones" Link to this property "app\_security" Link to this property "rules\_and\_configuration" Link to this property "cloudflare\_one\_and\_zero\_trust" Link to this property "analytics\_and\_logs" Link to this property "network\_services" Link to this property "media" Link to this property "email\_and\_messaging" Link to this property "cache\_and\_performance" Link to this property "account\_and\_billing" Link to this property "other" Link to this property
Link to this property is\_selectable: Optional\[bool] Whether the caller can select this permission group when creating a token. Link to this property name: Optional\[str] Permission Group Name Link to this property
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" Link to this property "com.cloudflare.api.account.zone" Link to this property "com.cloudflare.api.user" Link to this property "com.cloudflare.edge.r2.bucket" Link to this property
Link to this property
[Link to this property](<#(resource)%20accounts.tokens.permission_groups%20%3E%20(model)%20permission_group_list_response%20%3E%20(schema)>)
List\[PermissionGroupGetResponseItem] id: Optional\[str] Public ID. Link to this property
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" Link to this property "ai\_and\_machine\_learning" Link to this property "dns\_and\_zones" Link to this property "app\_security" Link to this property "rules\_and\_configuration" Link to this property "cloudflare\_one\_and\_zero\_trust" Link to this property "analytics\_and\_logs" Link to this property "network\_services" Link to this property "media" Link to this property "email\_and\_messaging" Link to this property "cache\_and\_performance" Link to this property "account\_and\_billing" Link to this property "other" Link to this property
Link to this property is\_selectable: Optional\[bool] Whether the caller can select this permission group when creating a token. Link to this property name: Optional\[str] Permission Group Name Link to this property
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" Link to this property "com.cloudflare.api.account.zone" Link to this property "com.cloudflare.api.user" Link to this property "com.cloudflare.edge.r2.bucket" Link to this property
Link to this property
[Link to this property](<#(resource)%20accounts.tokens.permission_groups%20%3E%20(model)%20permission_group_get_response%20%3E%20(schema)>) #### AccountsTokensValue ##### [Roll Token](https://developers.cloudflare.com/api/python/resources/accounts/subresources/tokens/subresources/value/methods/update) 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)](https://developers.cloudflare.com/api/python/resources/accounts/subresources/logs/subresources/audit/methods/list) 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)](https://developers.cloudflare.com/api/python/resources/accounts/subresources/logs/subresources/audit/methods/history) accounts.logs.audit.history(strid, AuditHistoryParams\*\*kwargs) -> [AuditHistoryResponse]() GET/accounts/{account\_id}/logs/audit/{id}/history ##### [List account audit log product categories (Version 2)](https://developers.cloudflare.com/api/python/resources/accounts/subresources/logs/subresources/audit/methods/product_categories) 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 Link to this property
account: Optional\[Account] Contains account related information. id: Optional\[str] A unique identifier for the account. Link to this property name: Optional\[str] A string that identifies the account name. Link to this property
Link to this property
action: Optional\[Action] Provides information about the action performed. description: Optional\[str] A short description of the action performed. Link to this property result: Optional\[str] The result of the action, indicating success or failure. Link to this property time: Optional\[datetime] A timestamp indicating when the action was logged. formatdate-time Link to this property type: Optional\[str] A short string that describes the action that was performed. Link to this property
Link to this property
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. Link to this property
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" Link to this property "api\_key" Link to this property "api\_token" Link to this property "dash" Link to this property "oauth" Link to this property "origin\_ca\_key" Link to this property
Link to this property email: Optional\[str] The email of the actor who performed the action. formatemail Link to this property ip\_address: Optional\[str] The IP address of the request that performed the action. Link to this property token\_id: Optional\[str] The API token ID when the actor context is an api\_token or oauth. Link to this property token\_name: Optional\[str] The API token name when the actor context is an api\_token or oauth. Link to this property
type: Optional\[Literal\["account", "cloudflare\_admin", "delegated\_service", 2 more]] The type of actor. One of the following: "account" Link to this property "cloudflare\_admin" Link to this property "delegated\_service" Link to this property "system" Link to this property "user" Link to this property
Link to this property
Link to this property
raw: Optional\[Raw] Provides raw information about the request and response. cf\_rayid: Optional\[str] The Cloudflare Ray ID for the request. Link to this property method: Optional\[str] The HTTP method of the request. Link to this property status\_code: Optional\[int] The HTTP response status code returned by the API. Link to this property uri: Optional\[str] The URI of the request. Link to this property user\_agent: Optional\[str] The client’s user agent string sent with the request. Link to this property
Link to this property
resource: Optional\[Resource] Provides details about the affected resource. id: Optional\[str] The unique identifier for the affected resource. Link to this property product: Optional\[str] The Cloudflare product associated with the resource. Link to this property request: Optional\[object] Link to this property response: Optional\[object] Link to this property scope: Optional\[object] The scope of the resource. Link to this property type: Optional\[str] The type of the resource. Link to this property
Link to this property
zone: Optional\[Zone] Provides details about the zone affected by the action. id: Optional\[str] A string that identifies the zone id. Link to this property name: Optional\[str] A string that identifies the zone name. Link to this property
Link to this property
[Link to this property](<#(resource)%20accounts.logs.audit%20%3E%20(model)%20audit_list_response%20%3E%20(schema)>)
List\[AuditHistoryResponseItem] id: Optional\[str] A unique identifier for the audit log entry. maxLength32 Link to this property
account: Optional\[AuditHistoryResponseItemAccount] Contains account related information. id: Optional\[str] A unique identifier for the account. Link to this property name: Optional\[str] A string that identifies the account name. Link to this property
Link to this property
action: Optional\[AuditHistoryResponseItemAction] Provides information about the action performed. description: Optional\[str] A short description of the action performed. Link to this property result: Optional\[str] The result of the action, indicating success or failure. Link to this property time: Optional\[datetime] A timestamp indicating when the action was logged. formatdate-time Link to this property type: Optional\[str] A short string that describes the action that was performed. Link to this property
Link to this property
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. Link to this property
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" Link to this property "api\_key" Link to this property "api\_token" Link to this property "dash" Link to this property "oauth" Link to this property "origin\_ca\_key" Link to this property
Link to this property email: Optional\[str] The email of the actor who performed the action. formatemail Link to this property ip\_address: Optional\[str] The IP address of the request that performed the action. Link to this property token\_id: Optional\[str] The API token ID when the actor context is an api\_token or oauth. Link to this property token\_name: Optional\[str] The API token name when the actor context is an api\_token or oauth. Link to this property
type: Optional\[Literal\["account", "cloudflare\_admin", "delegated\_service", 2 more]] The type of actor. One of the following: "account" Link to this property "cloudflare\_admin" Link to this property "delegated\_service" Link to this property "system" Link to this property "user" Link to this property
Link to this property
Link to this property
raw: Optional\[AuditHistoryResponseItemRaw] Provides raw information about the request and response. cf\_rayid: Optional\[str] The Cloudflare Ray ID for the request. Link to this property method: Optional\[str] The HTTP method of the request. Link to this property status\_code: Optional\[int] The HTTP response status code returned by the API. Link to this property uri: Optional\[str] The URI of the request. Link to this property user\_agent: Optional\[str] The client’s user agent string sent with the request. Link to this property
Link to this property
resource: Optional\[AuditHistoryResponseItemResource] Provides details about the affected resource. id: Optional\[str] The unique identifier for the affected resource. Link to this property product: Optional\[str] The Cloudflare product associated with the resource. Link to this property request: Optional\[object] Link to this property response: Optional\[object] Link to this property scope: Optional\[object] The scope of the resource. Link to this property type: Optional\[str] The type of the resource. Link to this property
Link to this property
zone: Optional\[AuditHistoryResponseItemZone] Provides details about the zone affected by the action. id: Optional\[str] A string that identifies the zone id. Link to this property name: Optional\[str] A string that identifies the zone name. Link to this property
Link to this property
[Link to this property](<#(resource)%20accounts.logs.audit%20%3E%20(model)%20audit_history_response%20%3E%20(schema)>)
class AuditProductCategoriesResponse: … A predefined product category and the resource products it expands to. label: Optional\[str] A human-readable label for the product category. Link to this property
products: Optional\[List\[Product]] The resource products that the product category expands to. label: Optional\[str] A human-readable label for the product. Link to this property value: Optional\[str] The resource\_product value that the product category expands to. Link to this property
Link to this property value: Optional\[str] The product category identifier used with the product\_category filter. Link to this property
[Link to this property](<#(resource)%20accounts.logs.audit%20%3E%20(model)%20audit_product_categories_response%20%3E%20(schema)>) #### AccountsEntitlements ##### [Get Account Entitlements](https://developers.cloudflare.com/api/python/resources/accounts/subresources/entitlements/methods/list) accounts.entitlements.list(EntitlementListParams\*\*kwargs) -> SyncSinglePage\[[EntitlementListResponse]()] GET/accounts/{account\_id}/entitlements ##### ModelsExpand Collapse
class EntitlementListResponse: … A single entitlement record for a zone or account. id: str Entitlement identifier — equal to the feature key. Link to this property
allocation: Allocation Represents the allocation value for an entitlement. The shape of value depends on type: bool uses a boolean, max_count uses an integer, enum_number uses an array of numbers, range uses an object with min and max integer fields, and string uses a string.
type: Literal\["bool", "max\_count", "enum\_number", 2 more] Allocation type discriminator. One of the following: "bool" Link to this property "max\_count" Link to this property "enum\_number" Link to this property "range" Link to this property "string" Link to this property
Link to this property
value: AllocationValue Contains the allocation value whose concrete type the type field determines: bool yields a boolean, max\_count yields an integer, enum\_number yields an array of numbers, range yields an object with min and max, and string yields a string. One of the following: bool Link to this property int Link to this property str Link to this property List\[float] Link to this property
class AllocationValueUnionMember4: … max: int Link to this property min: int Link to this property
Link to this property
Link to this property
Link to this property created\_date: str ISO 8601 timestamp (microsecond precision, no timezone offset) when the entitlement was created. Format: YYYY-MM-DDTHH:MM:SS.ffffff. Link to this property deleted\_date: str ISO 8601 timestamp when the entitlement was deleted, or empty string if not deleted. Link to this property edited\_date: str ISO 8601 timestamp (microsecond precision, no timezone offset) when the entitlement was last edited. Link to this property
feature: Feature Describes a product feature associated with an entitlement. id: int Numeric identifier of the feature. formatint64 Link to this property feature\_set: str The logical grouping (set) this feature belongs to. Link to this property key: str Unique string key for the feature. Link to this property name: str Human-readable name of the feature. Link to this property
Link to this property
[Link to this property](<#(resource)%20accounts.entitlements%20%3E%20(model)%20entitlement_list_response%20%3E%20(schema)>) #### AccountsSpeed Settings #### AccountsSpeed SettingsTransformations ##### [List Image Resizing configurations for account](https://developers.cloudflare.com/api/python/resources/accounts/subresources/speed_settings/subresources/transformations/methods/get) 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. Link to this property cf\_zone\_tag: Optional\[str] Zone tag identifier. Link to this property editable: Optional\[bool] Whether this setting can be modified. Link to this property modified\_on: Optional\[datetime] When this setting was last modified. formatdate-time Link to this property value: Optional\[str] Current value of the feature setting. Link to this property
[Link to this property](<#(resource)%20accounts.speed_settings.transformations%20%3E%20(model)%20transformations_config%20%3E%20(schema)>) #### AccountsPayment Methods ##### [List Payment Methods](https://developers.cloudflare.com/api/python/resources/accounts/subresources/payment_methods/methods/list) accounts.payment\_methods.list(PaymentMethodListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[PaymentMethodListResponse]()] GET/accounts/{account\_id}/payment-methods ##### [Create Payment Method](https://developers.cloudflare.com/api/python/resources/accounts/subresources/payment_methods/methods/create) accounts.payment\_methods.create(PaymentMethodCreateParams\*\*kwargs) -> [PaymentMethodCreateResponse]() POST/accounts/{account\_id}/payment-methods ##### [Get Payment Method](https://developers.cloudflare.com/api/python/resources/accounts/subresources/payment_methods/methods/get) accounts.payment\_methods.get(strpayment\_method\_id, PaymentMethodGetParams\*\*kwargs) -> [PaymentMethodGetResponse]() GET/accounts/{account\_id}/payment-methods/{payment\_method\_id} ##### [Update Payment Method](https://developers.cloudflare.com/api/python/resources/accounts/subresources/payment_methods/methods/update) accounts.payment\_methods.update(strpayment\_method\_id, PaymentMethodUpdateParams\*\*kwargs) -> [PaymentMethodUpdateResponse]() PUT/accounts/{account\_id}/payment-methods/{payment\_method\_id} ##### [Delete Payment Method](https://developers.cloudflare.com/api/python/resources/accounts/subresources/payment_methods/methods/delete) accounts.payment\_methods.delete(strpayment\_method\_id, PaymentMethodDeleteParams\*\*kwargs) -> [PaymentMethodDeleteResponse]() DELETE/accounts/{account\_id}/payment-methods/{payment\_method\_id} ##### [Set Default Payment Method](https://developers.cloudflare.com/api/python/resources/accounts/subresources/payment_methods/methods/set_as_default) 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. Link to this property address: Optional\[str] Billing address line 1. Link to this property address2: Optional\[str] Billing address line 2. Link to this property bank\_account\_type: Optional\[str] Bank account type. Link to this property bank\_code: Optional\[str] Bank code. Link to this property bank\_country: Optional\[str] Bank country. Link to this property bank\_name: Optional\[str] Bank name for bank-based payment methods. Link to this property bank\_routing\_number: Optional\[str] Bank routing number. Link to this property cashapp\_cash\_tag: Optional\[str] Cash App cash tag. Link to this property city: Optional\[str] Billing city. Link to this property country: Optional\[str] Billing country. Link to this property default: Optional\[bool] Whether this is the default payment method. Link to this property device\_data: Optional\[str] Device data for fraud prevention. Link to this property expiration\_date: Optional\[str] Card expiration date. Link to this property first\_name: Optional\[str] Billing first name. Link to this property last\_four: Optional\[str] Last four digits of the card number. Link to this property last\_name: Optional\[str] Billing last name. Link to this property nick\_name: Optional\[str] A nickname for the payment method. Link to this property payment\_account\_email: Optional\[str] Email associated with the payment account. Link to this property payment\_email: Optional\[str] Payment email address. Link to this property payment\_gateway: Optional\[str] The payment gateway used. Link to this property payment\_nonce: Optional\[str] Payment nonce for tokenized payments. Link to this property state: Optional\[str] Billing state. Link to this property
type: Optional\[Literal\["CREDIT\_CARD", "PAYPAL", "CASHAPP", 3 more]] The payment method type. One of the following: "CREDIT\_CARD" Link to this property "PAYPAL" Link to this property "CASHAPP" Link to this property "SEPA\_DEBIT" Link to this property "LINK" Link to this property "ACH\_DIRECT\_DEBIT" Link to this property
Link to this property zipcode: Optional\[str] Billing zip code. Link to this property
[Link to this property](<#(resource)%20accounts.payment_methods%20%3E%20(model)%20payment_method_list_response%20%3E%20(schema)>)
class PaymentMethodCreateResponse: … id: Optional\[str] Payment method identifier. Link to this property address: Optional\[str] Billing address line 1. Link to this property address2: Optional\[str] Billing address line 2. Link to this property bank\_account\_type: Optional\[str] Bank account type. Link to this property bank\_code: Optional\[str] Bank code. Link to this property bank\_country: Optional\[str] Bank country. Link to this property bank\_name: Optional\[str] Bank name for bank-based payment methods. Link to this property bank\_routing\_number: Optional\[str] Bank routing number. Link to this property cashapp\_cash\_tag: Optional\[str] Cash App cash tag. Link to this property city: Optional\[str] Billing city. Link to this property country: Optional\[str] Billing country. Link to this property default: Optional\[bool] Whether this is the default payment method. Link to this property device\_data: Optional\[str] Device data for fraud prevention. Link to this property expiration\_date: Optional\[str] Card expiration date. Link to this property first\_name: Optional\[str] Billing first name. Link to this property last\_four: Optional\[str] Last four digits of the card number. Link to this property last\_name: Optional\[str] Billing last name. Link to this property nick\_name: Optional\[str] A nickname for the payment method. Link to this property payment\_account\_email: Optional\[str] Email associated with the payment account. Link to this property payment\_email: Optional\[str] Payment email address. Link to this property payment\_gateway: Optional\[str] The payment gateway used. Link to this property payment\_nonce: Optional\[str] Payment nonce for tokenized payments. Link to this property state: Optional\[str] Billing state. Link to this property
type: Optional\[Literal\["CREDIT\_CARD", "PAYPAL", "CASHAPP", 3 more]] The payment method type. One of the following: "CREDIT\_CARD" Link to this property "PAYPAL" Link to this property "CASHAPP" Link to this property "SEPA\_DEBIT" Link to this property "LINK" Link to this property "ACH\_DIRECT\_DEBIT" Link to this property
Link to this property zipcode: Optional\[str] Billing zip code. Link to this property
[Link to this property](<#(resource)%20accounts.payment_methods%20%3E%20(model)%20payment_method_create_response%20%3E%20(schema)>)
class PaymentMethodGetResponse: … id: Optional\[str] Payment method identifier. Link to this property address: Optional\[str] Billing address line 1. Link to this property address2: Optional\[str] Billing address line 2. Link to this property bank\_account\_type: Optional\[str] Bank account type. Link to this property bank\_code: Optional\[str] Bank code. Link to this property bank\_country: Optional\[str] Bank country. Link to this property bank\_name: Optional\[str] Bank name for bank-based payment methods. Link to this property bank\_routing\_number: Optional\[str] Bank routing number. Link to this property cashapp\_cash\_tag: Optional\[str] Cash App cash tag. Link to this property city: Optional\[str] Billing city. Link to this property country: Optional\[str] Billing country. Link to this property default: Optional\[bool] Whether this is the default payment method. Link to this property device\_data: Optional\[str] Device data for fraud prevention. Link to this property expiration\_date: Optional\[str] Card expiration date. Link to this property first\_name: Optional\[str] Billing first name. Link to this property last\_four: Optional\[str] Last four digits of the card number. Link to this property last\_name: Optional\[str] Billing last name. Link to this property nick\_name: Optional\[str] A nickname for the payment method. Link to this property payment\_account\_email: Optional\[str] Email associated with the payment account. Link to this property payment\_email: Optional\[str] Payment email address. Link to this property payment\_gateway: Optional\[str] The payment gateway used. Link to this property payment\_nonce: Optional\[str] Payment nonce for tokenized payments. Link to this property state: Optional\[str] Billing state. Link to this property
type: Optional\[Literal\["CREDIT\_CARD", "PAYPAL", "CASHAPP", 3 more]] The payment method type. One of the following: "CREDIT\_CARD" Link to this property "PAYPAL" Link to this property "CASHAPP" Link to this property "SEPA\_DEBIT" Link to this property "LINK" Link to this property "ACH\_DIRECT\_DEBIT" Link to this property
Link to this property zipcode: Optional\[str] Billing zip code. Link to this property
[Link to this property](<#(resource)%20accounts.payment_methods%20%3E%20(model)%20payment_method_get_response%20%3E%20(schema)>)
class PaymentMethodUpdateResponse: … id: Optional\[str] Payment method identifier. Link to this property address: Optional\[str] Billing address line 1. Link to this property address2: Optional\[str] Billing address line 2. Link to this property bank\_account\_type: Optional\[str] Bank account type. Link to this property bank\_code: Optional\[str] Bank code. Link to this property bank\_country: Optional\[str] Bank country. Link to this property bank\_name: Optional\[str] Bank name for bank-based payment methods. Link to this property bank\_routing\_number: Optional\[str] Bank routing number. Link to this property cashapp\_cash\_tag: Optional\[str] Cash App cash tag. Link to this property city: Optional\[str] Billing city. Link to this property country: Optional\[str] Billing country. Link to this property default: Optional\[bool] Whether this is the default payment method. Link to this property device\_data: Optional\[str] Device data for fraud prevention. Link to this property expiration\_date: Optional\[str] Card expiration date. Link to this property first\_name: Optional\[str] Billing first name. Link to this property last\_four: Optional\[str] Last four digits of the card number. Link to this property last\_name: Optional\[str] Billing last name. Link to this property nick\_name: Optional\[str] A nickname for the payment method. Link to this property payment\_account\_email: Optional\[str] Email associated with the payment account. Link to this property payment\_email: Optional\[str] Payment email address. Link to this property payment\_gateway: Optional\[str] The payment gateway used. Link to this property payment\_nonce: Optional\[str] Payment nonce for tokenized payments. Link to this property state: Optional\[str] Billing state. Link to this property
type: Optional\[Literal\["CREDIT\_CARD", "PAYPAL", "CASHAPP", 3 more]] The payment method type. One of the following: "CREDIT\_CARD" Link to this property "PAYPAL" Link to this property "CASHAPP" Link to this property "SEPA\_DEBIT" Link to this property "LINK" Link to this property "ACH\_DIRECT\_DEBIT" Link to this property
Link to this property zipcode: Optional\[str] Billing zip code. Link to this property
[Link to this property](<#(resource)%20accounts.payment_methods%20%3E%20(model)%20payment_method_update_response%20%3E%20(schema)>)
Union\[Optional\[str], Optional\[object]] One of the following: Optional\[str] Link to this property Optional\[object] Link to this property
[Link to this property](<#(resource)%20accounts.payment_methods%20%3E%20(model)%20payment_method_delete_response%20%3E%20(schema)>)
Union\[Optional\[str], Optional\[object]] One of the following: Optional\[str] Link to this property Optional\[object] Link to this property
[Link to this property](<#(resource)%20accounts.payment_methods%20%3E%20(model)%20payment_method_set_as_default_response%20%3E%20(schema)>) #### AccountsPay Invoice ##### [Pay Invoice](https://developers.cloudflare.com/api/python/resources/accounts/subresources/pay_invoice/methods/create) 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. Link to this property
[Link to this property](<#(resource)%20accounts.pay_invoice%20%3E%20(model)%20pay_invoice_create_response%20%3E%20(schema)>) #### AccountsPay Bad Debt ##### [Pay Bad Debt](https://developers.cloudflare.com/api/python/resources/accounts/subresources/pay_bad_debt/methods/create) 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. Link to this property
[Link to this property](<#(resource)%20accounts.pay_bad_debt%20%3E%20(model)%20pay_bad_debt_create_response%20%3E%20(schema)>) #### AccountsReceipts ##### [Get Receipt PDF](https://developers.cloudflare.com/api/python/resources/accounts/subresources/receipts/methods/pdf) accounts.receipts.pdf(strreceipt\_id, ReceiptPDFParams\*\*kwargs) -> BinaryResponseContent GET/accounts/{account\_id}/receipts/{receipt\_id}/pdf #### AccountsInvoices ##### [Toggle PDF Invoices](https://developers.cloudflare.com/api/python/resources/accounts/subresources/invoices/methods/edit) accounts.invoices.edit(InvoiceEditParams\*\*kwargs) -> [InvoiceEditResponse]() PATCH/accounts/{account\_id}/invoices ##### ModelsExpand Collapse
Union\[Optional\[str], Optional\[object]] One of the following: Optional\[str] Link to this property Optional\[object] Link to this property
[Link to this property](<#(resource)%20accounts.invoices%20%3E%20(model)%20invoice_edit_response%20%3E%20(schema)>) #### AccountsClient Secret ##### [Create Setup Intent](https://developers.cloudflare.com/api/python/resources/accounts/subresources/client_secret/methods/create) 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. Link to this property
[Link to this property](<#(resource)%20accounts.client_secret%20%3E%20(model)%20client_secret_create_response%20%3E%20(schema)>)