Skip to content
Cloudflare API
Start here
API Reference
Accounts

Subscriptions

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]

SubscriptionsCancel 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.

SubscriptionsActions

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

SubscriptionsBulk

Create Subscriptions
accounts.subscriptions.bulk.create(BulkCreateParams**kwargs) -> BulkCreateResponse
POST/accounts/{account_id}/bulk/subscriptions
ModelsExpand Collapse
class BulkCreateResponse: …
client_secrets: Optional[List[str]]
subscriptions: Optional[List[Subscription]]
id: Optional[str]

Subscription identifier tag.

maxLength32
currency: Optional[str]

The monetary unit in which pricing information is displayed.

current_period_end: Optional[datetime]

The end of the current period and also when the next billing is due.

formatdate-time
current_period_start: Optional[datetime]

When the current billing period started. May match initial_period_start if this is the first period.

formatdate-time
frequency: Optional[Literal["weekly", "monthly", "quarterly", "yearly"]]

How often the subscription is renewed automatically.

One of the following:
"weekly"
"monthly"
"quarterly"
"yearly"
price: Optional[float]

The price of the subscription that will be billed, in US dollars.

rate_plan: Optional[RatePlan]

The rate plan applied to the subscription.

state: Optional[Literal["Trial", "Provisioned", "Paid", 4 more]]

The state that the subscription is in.

One of the following:
"Trial"
"Provisioned"
"Paid"
"AwaitingPayment"
"Cancelled"
"Failed"
"Expired"