---
title: Subscriptions
---

[Skip to content](#_top)

[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#(resource)%20%24shared%20%3E%20(model)%20subscription%20%3E%20(schema)>) {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_by_identifier)

client.accounts.subscriptions.getByIdentifier(stringsubscriptionIdentifier, SubscriptionGetByIdentifierParams {account\_id } params, RequestOptionsoptions?): [Subscription](<https://developers.cloudflare.com/api/typescript/resources/$shared#(resource)%20%24shared%20%3E%20(model)%20subscription%20%3E%20(schema)>) {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#(resource)%20%24shared%20%3E%20(model)%20subscription%20%3E%20(schema)>) {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#(resource)%20%24shared%20%3E%20(model)%20subscription%20%3E%20(schema)>) {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#(resource)%20accounts.subscriptions%20%3E%20(model)%20subscription_delete_response%20%3E%20(schema)>) {subscription\_id }

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

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

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

POST/accounts/{account\_id}/subscriptions/cancel-downgrade

##### ModelsExpand Collapse

<details>

<summary>

SubscriptionDeleteResponse {subscription\_id }

</summary>

subscription\_id?: string

Subscription identifier tag.

maxLength32

<a href="#(resource)%20accounts.subscriptions%20%3E%20(model)%20subscription_delete_response%20%3E%20(schema)%20%3E%20(property)%20subscription_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20accounts.subscriptions%20%3E%20(model)%20subscription_delete_response%20%3E%20(schema)>)

<details>

<summary>

SubscriptionCancelDowngradeResponse = unknown| string| null

</summary>

One of the following:

unknown

<a href="#(resource)%20accounts.subscriptions%20%3E%20(model)%20subscription_cancel_downgrade_response%20%3E%20(schema)%20%3E%20(variant)%200">Link to this property</a>

string| null

<a href="#(resource)%20accounts.subscriptions%20%3E%20(model)%20subscription_cancel_downgrade_response%20%3E%20(schema)%20%3E%20(variant)%201">Link to this property</a>

</details>

[Link to this property](<#(resource)%20accounts.subscriptions%20%3E%20(model)%20subscription_cancel_downgrade_response%20%3E%20(schema)>)

#### SubscriptionsCancel Reason

##### [Create Cancel Reason](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/subscriptions/subresources/cancel_reason/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#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_create_response%20%3E%20(schema)>) {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_reason/methods/get)

client.accounts.subscriptions.cancelReason.get(stringsubscriptionIdentifier, CancelReasonGetParams {account\_id } params, RequestOptionsoptions?): [CancelReasonGetResponse](<https://developers.cloudflare.com/api/typescript/resources/accounts#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_get_response%20%3E%20(schema)>) {id, other, reason\_code, 2 more }

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

##### ModelsExpand Collapse

<details>

<summary>

CancelReasonCreateResponse {id, other, reason\_code, 2 more }

</summary>

id?: string

The cancel reason identifier.

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_create_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

other?: string

Additional cancellation details.

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_create_response%20%3E%20(schema)%20%3E%20(property)%20other">Link to this property</a>

reason\_code?: Array&lt;string&gt;

The cancellation reason codes.

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_create_response%20%3E%20(schema)%20%3E%20(property)%20reason_code">Link to this property</a>

submitted?: string

When the cancel reason was submitted.

formatdate-time

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_create_response%20%3E%20(schema)%20%3E%20(property)%20submitted">Link to this property</a>

subscription\_id?: string

The subscription identifier.

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_create_response%20%3E%20(schema)%20%3E%20(property)%20subscription_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_create_response%20%3E%20(schema)>)

<details>

<summary>

CancelReasonGetResponse {id, other, reason\_code, 2 more }

</summary>

id?: string

The cancel reason identifier.

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_get_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

other?: string

Additional cancellation details.

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_get_response%20%3E%20(schema)%20%3E%20(property)%20other">Link to this property</a>

reason\_code?: Array&lt;string&gt;

The cancellation reason codes.

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_get_response%20%3E%20(schema)%20%3E%20(property)%20reason_code">Link to this property</a>

submitted?: string

When the cancel reason was submitted.

formatdate-time

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_get_response%20%3E%20(schema)%20%3E%20(property)%20submitted">Link to this property</a>

subscription\_id?: string

The subscription identifier.

<a href="#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_get_response%20%3E%20(schema)%20%3E%20(property)%20subscription_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20accounts.subscriptions.cancel_reason%20%3E%20(model)%20cancel_reason_get_response%20%3E%20(schema)>)

#### 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#(resource)%20%24shared%20%3E%20(model)%20subscription%20%3E%20(schema)>) {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#(resource)%20accounts.subscriptions.bulk%20%3E%20(model)%20bulk_create_response%20%3E%20(schema)>)| null

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

##### ModelsExpand Collapse

BulkCreateResponse = Array<unknown>| null

[Link to this property](<#(resource)%20accounts.subscriptions.bulk%20%3E%20(model)%20bulk_create_response%20%3E%20(schema)>)