Skip to content
Cloudflare API
Start here
API Reference
Accounts

Subscriptions

List Subscriptions
client.accounts.subscriptions.get(SubscriptionGetParams { account_id, zone_id } params?, RequestOptionsoptions?): SinglePage<Subscription { id, currency, current_period_end, 5 more } >
GET/{accounts_or_zones}/{account_or_zone_id}/subscriptions
Get Subscription
client.accounts.subscriptions.getByIdentifier(stringsubscriptionIdentifier, SubscriptionGetByIdentifierParams { account_id } params, RequestOptionsoptions?): Subscription { id, currency, current_period_end, 5 more }
GET/accounts/{account_id}/subscriptions/{subscription_identifier}
Create Subscription
client.accounts.subscriptions.create(SubscriptionCreateParams { account_id, zone_id, frequency, rate_plan } params, RequestOptionsoptions?): Subscription { id, currency, current_period_end, 5 more }
POST/{accounts_or_zones}/{account_or_zone_id}/subscriptions
Update Subscription
client.accounts.subscriptions.update(stringsubscriptionIdentifier, SubscriptionUpdateParams { account_id, frequency, rate_plan } params, RequestOptionsoptions?): Subscription { id, currency, current_period_end, 5 more }
PUT/accounts/{account_id}/subscriptions/{subscription_identifier}
Delete Subscription
client.accounts.subscriptions.delete(stringsubscriptionIdentifier, SubscriptionDeleteParams { account_id } params, RequestOptionsoptions?): SubscriptionDeleteResponse { subscription_id }
DELETE/accounts/{account_id}/subscriptions/{subscription_identifier}
Cancel Delayed Downgrade
client.accounts.subscriptions.cancelDowngrade(SubscriptionCancelDowngradeParams { account_id, subscription_ids } params, RequestOptionsoptions?): SubscriptionCancelDowngradeResponse
POST/accounts/{account_id}/subscriptions/cancel-downgrade
ModelsExpand Collapse
SubscriptionDeleteResponse { subscription_id }
subscription_id?: string

Subscription identifier tag.

maxLength32
SubscriptionCancelDowngradeResponse = unknown | string | null
One of the following:
unknown
string | null

SubscriptionsCancel Reason

Create Cancel Reason
client.accounts.subscriptions.cancelReason.create(stringsubscriptionIdentifier, CancelReasonCreateParams { account_id, other, reason_code } params, RequestOptionsoptions?): CancelReasonCreateResponse { id, other, reason_code, 2 more }
POST/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason
Get Cancel Reason
client.accounts.subscriptions.cancelReason.get(stringsubscriptionIdentifier, CancelReasonGetParams { account_id } params, RequestOptionsoptions?): CancelReasonGetResponse { id, other, reason_code, 2 more }
GET/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason
ModelsExpand Collapse
CancelReasonCreateResponse { id, other, reason_code, 2 more }
id?: string

The cancel reason identifier.

other?: string

Additional cancellation details.

reason_code?: Array<string>

The cancellation reason codes.

submitted?: string

When the cancel reason was submitted.

formatdate-time
subscription_id?: string

The subscription identifier.

CancelReasonGetResponse { id, other, reason_code, 2 more }
id?: string

The cancel reason identifier.

other?: string

Additional cancellation details.

reason_code?: Array<string>

The cancellation reason codes.

submitted?: string

When the cancel reason was submitted.

formatdate-time
subscription_id?: string

The subscription identifier.

SubscriptionsActions

Append Subscription Action
client.accounts.subscriptions.actions.append(stringsubscriptionIdentifier, ActionAppendParams { account_id, frequency, rate_plan } params, RequestOptionsoptions?): Subscription { id, currency, current_period_end, 5 more }
POST/accounts/{account_id}/subscriptions/{subscription_identifier}/action/append

SubscriptionsBulk

Create Subscriptions
client.accounts.subscriptions.bulk.create(BulkCreateParams { account_id, idemp_key, coupon_code, 3 more } params, RequestOptionsoptions?): BulkCreateResponse | null
POST/accounts/{account_id}/bulk/subscriptions
ModelsExpand Collapse
BulkCreateResponse = Array<unknown> | null