---
title: Subscriptions
---

[Skip to content](#%5Ftop) 

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

[Zones](https://developers.cloudflare.com/api/typescript/resources/zones)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Subscriptions

##### [Zone Subscription Details](https://developers.cloudflare.com/api/typescript/resources/zones/subresources/subscriptions/methods/get)

client.zones.subscriptions.get(SubscriptionGetParams { zone\_id } params, RequestOptionsoptions?): [SubscriptionGetResponse](https://developers.cloudflare.com/api/typescript/resources/zones#%28resource%29%20zones.subscriptions%20%3E%20%28model%29%20subscription%5Fget%5Fresponse%20%3E%20%28schema%29) { id, currency, current\_period\_end, 5 more } 

GET/zones/{zone\_id}/subscription

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

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

POST/zones/{zone\_id}/subscription

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

client.zones.subscriptions.update(SubscriptionUpdateParams { zone\_id, frequency, rate\_plan } params, RequestOptionsoptions?): [SubscriptionUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/zones#%28resource%29%20zones.subscriptions%20%3E%20%28model%29%20subscription%5Fupdate%5Fresponse%20%3E%20%28schema%29) { id, currency, current\_period\_end, 5 more } 

PUT/zones/{zone\_id}/subscription

##### ModelsExpand Collapse 

SubscriptionGetResponse { id, currency, current\_period\_end, 5 more } 

id?: string

Subscription identifier tag.

maxLength32

currency?: string

The monetary unit in which pricing information is displayed.

current\_period\_end?: string

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

formatdate-time

current\_period\_start?: string

When the current billing period started. May match initial\_period\_start if this is the first period.

formatdate-time

frequency?: "weekly" | "monthly" | "quarterly" | 2 more

How often the subscription is renewed automatically.

One of the following:

"weekly"

"monthly"

"quarterly"

"yearly"

"not-applicable"

price?: number

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

rate\_plan?: [RatePlan](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20rate%5Fplan%20%3E%20%28schema%29) { id, currency, externally\_managed, 4 more } 

The rate plan applied to the subscription.

state?: "Trial" | "Provisioned" | "Paid" | 4 more

The state that the subscription is in.

One of the following:

"Trial"

"Provisioned"

"Paid"

"AwaitingPayment"

"Cancelled"

"Failed"

"Expired"

SubscriptionCreateResponse { id, currency, current\_period\_end, 5 more } 

id?: string

Subscription identifier tag.

maxLength32

currency?: string

The monetary unit in which pricing information is displayed.

current\_period\_end?: string

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

formatdate-time

current\_period\_start?: string

When the current billing period started. May match initial\_period\_start if this is the first period.

formatdate-time

frequency?: "weekly" | "monthly" | "quarterly" | 2 more

How often the subscription is renewed automatically.

One of the following:

"weekly"

"monthly"

"quarterly"

"yearly"

"not-applicable"

price?: number

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

rate\_plan?: [RatePlan](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20rate%5Fplan%20%3E%20%28schema%29) { id, currency, externally\_managed, 4 more } 

The rate plan applied to the subscription.

state?: "Trial" | "Provisioned" | "Paid" | 4 more

The state that the subscription is in.

One of the following:

"Trial"

"Provisioned"

"Paid"

"AwaitingPayment"

"Cancelled"

"Failed"

"Expired"

SubscriptionUpdateResponse { id, currency, current\_period\_end, 5 more } 

id?: string

Subscription identifier tag.

maxLength32

currency?: string

The monetary unit in which pricing information is displayed.

current\_period\_end?: string

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

formatdate-time

current\_period\_start?: string

When the current billing period started. May match initial\_period\_start if this is the first period.

formatdate-time

frequency?: "weekly" | "monthly" | "quarterly" | 2 more

How often the subscription is renewed automatically.

One of the following:

"weekly"

"monthly"

"quarterly"

"yearly"

"not-applicable"

price?: number

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

rate\_plan?: [RatePlan](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20rate%5Fplan%20%3E%20%28schema%29) { id, currency, externally\_managed, 4 more } 

The rate plan applied to the subscription.

state?: "Trial" | "Provisioned" | "Paid" | 4 more

The state that the subscription is in.

One of the following:

"Trial"

"Provisioned"

"Paid"

"AwaitingPayment"

"Cancelled"

"Failed"

"Expired"