--- title: Zone Subscription Details --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Zones](https://developers.cloudflare.com/api/python/resources/zones) [Subscriptions](https://developers.cloudflare.com/api/python/resources/zones/subresources/subscriptions) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Zone Subscription Details zones.subscriptions.get(SubscriptionGetParams\*\*kwargs) -> [SubscriptionGetResponse]() GET/zones/{zone\_id}/subscription Lists zone subscription details. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Billing Write``Billing Read` ##### ParametersExpand Collapse zone\_id: str Identifier maxLength32 [Link to this property](<#(resource)%20zones.subscriptions%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class SubscriptionGetResponse: … id: Optional\[str] Subscription identifier tag. maxLength32 Link to this property currency: Optional\[str] The monetary unit in which pricing information is displayed. Link to this property current\_period\_end: Optional\[datetime] The end of the current period and also when the next billing is due. formatdate-time Link to this property current\_period\_start: Optional\[datetime] When the current billing period started. May match initial\_period\_start if this is the first period. formatdate-time Link to this property
frequency: Optional\[Literal\["weekly", "monthly", "quarterly", 2 more]] How often the subscription is renewed automatically. One of the following: "weekly" Link to this property "monthly" Link to this property "quarterly" Link to this property "yearly" Link to this property "not-applicable" Link to this property
Link to this property price: Optional\[float] The price of the subscription that will be billed, in US dollars. Link to this property
rate\_plan: Optional\[RatePlan] The rate plan applied to the subscription.
id: Optional\[Literal\["free", "lite", "pro", 7 more]] The ID of the rate plan. One of the following: "free" Link to this property "lite" Link to this property "pro" Link to this property "pro\_plus" Link to this property "business" Link to this property "enterprise" Link to this property "partners\_free" Link to this property "partners\_pro" Link to this property "partners\_business" Link to this property "partners\_enterprise" Link to this property
Link to this property currency: Optional\[str] The currency applied to the rate plan subscription. Link to this property externally\_managed: Optional\[bool] Whether this rate plan is managed externally from Cloudflare. Link to this property is\_contract: Optional\[bool] Whether a rate plan is enterprise-based (or newly adopted term contract). Link to this property public\_name: Optional\[str] The full name of the rate plan. Link to this property scope: Optional\[str] The scope that this rate plan applies to. Link to this property sets: Optional\[List\[str]] The list of sets this rate plan applies to. Returns array of strings. Link to this property
Link to this property
state: Optional\[Literal\["Trial", "Provisioned", "Paid", 4 more]] The state that the subscription is in. One of the following: "Trial" Link to this property "Provisioned" Link to this property "Paid" Link to this property "AwaitingPayment" Link to this property "Cancelled" Link to this property "Failed" Link to this property "Expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)>) ### Zone Subscription Details Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) subscription = client.zones.subscriptions.get( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(subscription.id) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "506e3185e9c882d175a2d0cb0093d9f2", "currency": "USD", "current_period_end": "2014-03-31T12:20:00Z", "current_period_start": "2014-05-11T12:20:00Z", "frequency": "monthly", "price": 20, "rate_plan": { "id": "free", "currency": "USD", "externally_managed": false, "is_contract": false, "public_name": "Business Plan", "scope": "zone", "sets": [ "string" ] }, "state": "Paid" }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "506e3185e9c882d175a2d0cb0093d9f2", "currency": "USD", "current_period_end": "2014-03-31T12:20:00Z", "current_period_start": "2014-05-11T12:20:00Z", "frequency": "monthly", "price": 20, "rate_plan": { "id": "free", "currency": "USD", "externally_managed": false, "is_contract": false, "public_name": "Business Plan", "scope": "zone", "sets": [ "string" ] }, "state": "Paid" }, "success": true } ```