---
title: Subscriptions
---

[Skip to content](#_top)

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

[Zones](https://developers.cloudflare.com/api/python/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/python/resources/zones/subresources/subscriptions/methods/get)

zones.subscriptions.get(SubscriptionGetParams\*\*kwargs) -> [SubscriptionGetResponse](<https://developers.cloudflare.com/api/python/resources/zones#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/subscription

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

zones.subscriptions.create(SubscriptionCreateParams\*\*kwargs) -> [SubscriptionCreateResponse](<https://developers.cloudflare.com/api/python/resources/zones#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/subscription

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

zones.subscriptions.update(SubscriptionUpdateParams\*\*kwargs) -> [SubscriptionUpdateResponse](<https://developers.cloudflare.com/api/python/resources/zones#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)>)

PUT/zones/{zone\_id}/subscription

##### ModelsExpand Collapse

<details>

<summary>

class SubscriptionGetResponse: …

</summary>

id: Optional\[str]

Subscription identifier tag.

maxLength32

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

currency: Optional\[str]

The monetary unit in which pricing information is displayed.

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20currency">Link to this property</a>

current\_period\_end: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20current_period_end">Link to this property</a>

current\_period\_start: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20current_period_start">Link to this property</a>

<details>

<summary>

frequency: Optional\[Literal\["weekly", "monthly", "quarterly", 2 more]]

How often the subscription is renewed automatically.

</summary>

One of the following:

"weekly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%200">Link to this property</a>

"monthly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%201">Link to this property</a>

"quarterly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%202">Link to this property</a>

"yearly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%203">Link to this property</a>

"not-applicable"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%204">Link to this property</a>

</details>

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20frequency">Link to this property</a>

price: Optional\[float]

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

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20price">Link to this property</a>

rate\_plan: Optional\[RatePlan]

The rate plan applied to the subscription.

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20rate_plan">Link to this property</a>

<details>

<summary>

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

The state that the subscription is in.

</summary>

One of the following:

"Trial"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

"Provisioned"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

"Paid"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%202">Link to this property</a>

"AwaitingPayment"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%203">Link to this property</a>

"Cancelled"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%204">Link to this property</a>

"Failed"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%205">Link to this property</a>

"Expired"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%206">Link to this property</a>

</details>

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)%20%3E%20(property)%20state">Link to this property</a>

</details>

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

<details>

<summary>

class SubscriptionCreateResponse: …

</summary>

id: Optional\[str]

Subscription identifier tag.

maxLength32

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

currency: Optional\[str]

The monetary unit in which pricing information is displayed.

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20currency">Link to this property</a>

current\_period\_end: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20current_period_end">Link to this property</a>

current\_period\_start: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20current_period_start">Link to this property</a>

<details>

<summary>

frequency: Optional\[Literal\["weekly", "monthly", "quarterly", 2 more]]

How often the subscription is renewed automatically.

</summary>

One of the following:

"weekly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%200">Link to this property</a>

"monthly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%201">Link to this property</a>

"quarterly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%202">Link to this property</a>

"yearly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%203">Link to this property</a>

"not-applicable"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%204">Link to this property</a>

</details>

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20frequency">Link to this property</a>

price: Optional\[float]

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

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20price">Link to this property</a>

rate\_plan: Optional\[RatePlan]

The rate plan applied to the subscription.

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20rate_plan">Link to this property</a>

<details>

<summary>

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

The state that the subscription is in.

</summary>

One of the following:

"Trial"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

"Provisioned"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

"Paid"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%202">Link to this property</a>

"AwaitingPayment"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%203">Link to this property</a>

"Cancelled"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%204">Link to this property</a>

"Failed"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%205">Link to this property</a>

"Expired"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%206">Link to this property</a>

</details>

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)%20%3E%20(property)%20state">Link to this property</a>

</details>

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

<details>

<summary>

class SubscriptionUpdateResponse: …

</summary>

id: Optional\[str]

Subscription identifier tag.

maxLength32

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

currency: Optional\[str]

The monetary unit in which pricing information is displayed.

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20currency">Link to this property</a>

current\_period\_end: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20current_period_end">Link to this property</a>

current\_period\_start: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20current_period_start">Link to this property</a>

<details>

<summary>

frequency: Optional\[Literal\["weekly", "monthly", "quarterly", 2 more]]

How often the subscription is renewed automatically.

</summary>

One of the following:

"weekly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%200">Link to this property</a>

"monthly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%201">Link to this property</a>

"quarterly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%202">Link to this property</a>

"yearly"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%203">Link to this property</a>

"not-applicable"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20frequency%20%3E%20(member)%204">Link to this property</a>

</details>

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20frequency">Link to this property</a>

price: Optional\[float]

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

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20price">Link to this property</a>

rate\_plan: Optional\[RatePlan]

The rate plan applied to the subscription.

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20rate_plan">Link to this property</a>

<details>

<summary>

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

The state that the subscription is in.

</summary>

One of the following:

"Trial"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

"Provisioned"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

"Paid"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%202">Link to this property</a>

"AwaitingPayment"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%203">Link to this property</a>

"Cancelled"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%204">Link to this property</a>

"Failed"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%205">Link to this property</a>

"Expired"

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%206">Link to this property</a>

</details>

<a href="#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)%20%3E%20(property)%20state">Link to this property</a>

</details>

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