---
title: Subscriptions
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Accounts](https://developers.cloudflare.com/api/typescript/resources/accounts)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Subscriptions

##### [List Subscriptions](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/methods/get)

client.accounts.subscriptions.get(SubscriptionGetParams { account\_id, zone\_id } params?, RequestOptionsoptions?): SinglePage<[Subscription](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20subscription%20%3E%20%28schema%29) { id, currency, current\_period\_end, 5 more } \>

GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/subscriptions

##### [Get Subscription](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/methods/get%5Fby%5Fidentifier)

client.accounts.subscriptions.getByIdentifier(stringsubscriptionIdentifier, SubscriptionGetByIdentifierParams { account\_id } params, RequestOptionsoptions?): [Subscription](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20subscription%20%3E%20%28schema%29) { id, currency, current\_period\_end, 5 more } 

GET/accounts/{account\_id}/subscriptions/{subscription\_identifier}

##### [Create Subscription](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/methods/create)

client.accounts.subscriptions.create(SubscriptionCreateParams { account\_id, zone\_id, frequency, rate\_plan } params, RequestOptionsoptions?): [Subscription](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20subscription%20%3E%20%28schema%29) { id, currency, current\_period\_end, 5 more } 

POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/subscriptions

##### [Update Subscription](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/methods/update)

client.accounts.subscriptions.update(stringsubscriptionIdentifier, SubscriptionUpdateParams { account\_id, frequency, rate\_plan } params, RequestOptionsoptions?): [Subscription](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20subscription%20%3E%20%28schema%29) { id, currency, current\_period\_end, 5 more } 

PUT/accounts/{account\_id}/subscriptions/{subscription\_identifier}

##### [Delete Subscription](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/methods/delete)

client.accounts.subscriptions.delete(stringsubscriptionIdentifier, SubscriptionDeleteParams { account\_id } params, RequestOptionsoptions?): [SubscriptionDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/accounts#%28resource%29%20accounts.subscriptions%20%3E%20%28model%29%20subscription%5Fdelete%5Fresponse%20%3E%20%28schema%29) { subscription\_id } 

DELETE/accounts/{account\_id}/subscriptions/{subscription\_identifier}

##### [Cancel Delayed Downgrade](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/methods/cancel%5Fdowngrade)

client.accounts.subscriptions.cancelDowngrade(SubscriptionCancelDowngradeParams { account\_id, subscription\_ids } params, RequestOptionsoptions?): [SubscriptionCancelDowngradeResponse](https://developers.cloudflare.com/api/typescript/resources/accounts#%28resource%29%20accounts.subscriptions%20%3E%20%28model%29%20subscription%5Fcancel%5Fdowngrade%5Fresponse%20%3E%20%28schema%29)

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](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/subresources/cancel%5Freason/methods/create)

client.accounts.subscriptions.cancelReason.create(stringsubscriptionIdentifier, CancelReasonCreateParams { account\_id, other, reason\_code } params, RequestOptionsoptions?): [CancelReasonCreateResponse](https://developers.cloudflare.com/api/typescript/resources/accounts#%28resource%29%20accounts.subscriptions.cancel%5Freason%20%3E%20%28model%29%20cancel%5Freason%5Fcreate%5Fresponse%20%3E%20%28schema%29) { id, other, reason\_code, 2 more } 

POST/accounts/{account\_id}/subscriptions/{subscription\_identifier}/cancel-reason

##### [Get Cancel Reason](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/subresources/cancel%5Freason/methods/get)

client.accounts.subscriptions.cancelReason.get(stringsubscriptionIdentifier, CancelReasonGetParams { account\_id } params, RequestOptionsoptions?): [CancelReasonGetResponse](https://developers.cloudflare.com/api/typescript/resources/accounts#%28resource%29%20accounts.subscriptions.cancel%5Freason%20%3E%20%28model%29%20cancel%5Freason%5Fget%5Fresponse%20%3E%20%28schema%29) { 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](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/subresources/actions/methods/append)

client.accounts.subscriptions.actions.append(stringsubscriptionIdentifier, ActionAppendParams { account\_id, frequency, rate\_plan } params, RequestOptionsoptions?): [Subscription](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20subscription%20%3E%20%28schema%29) { id, currency, current\_period\_end, 5 more } 

POST/accounts/{account\_id}/subscriptions/{subscription\_identifier}/action/append

#### SubscriptionsBulk

##### [Create Subscriptions](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/subresources/bulk/methods/create)

client.accounts.subscriptions.bulk.create(BulkCreateParams { account\_id, idemp\_key, coupon\_code, 3 more } params, RequestOptionsoptions?): [BulkCreateResponse](https://developers.cloudflare.com/api/typescript/resources/accounts#%28resource%29%20accounts.subscriptions.bulk%20%3E%20%28model%29%20bulk%5Fcreate%5Fresponse%20%3E%20%28schema%29) | null

POST/accounts/{account\_id}/bulk/subscriptions

##### ModelsExpand Collapse 

BulkCreateResponse \= Array<unknown\> | null