--- title: Get Subscription --- [Skip to content](#%5Ftop) [API Reference](https://developers.cloudflare.com/api) [Accounts](https://developers.cloudflare.com/api/resources/accounts) [Subscriptions](https://developers.cloudflare.com/api/resources/accounts/subresources/subscriptions) Copy Markdown Open in **Claude** Open in **ChatGPT** Open in **Cursor** --- **Copy Markdown** **View as Markdown** # Get Subscription GET/accounts/{account\_id}/subscriptions/{subscription\_identifier} Gets an account subscription by identifier. ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-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` ##### Path ParametersExpand Collapse account\_id: string Identifier maxLength32 subscription\_identifier: string Subscription identifier tag. maxLength32 ##### ReturnsExpand Collapse errors: array of [ResponseInfo](https://developers.cloudflare.com/api/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20response%5Finfo%20%3E%20%28schema%29) { code, message, documentation\_url, source } code: number minimum1000 message: string documentation\_url: optional string source: optional object { pointer } pointer: optional string messages: array of [ResponseInfo](https://developers.cloudflare.com/api/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20response%5Finfo%20%3E%20%28schema%29) { code, message, documentation\_url, source } code: number minimum1000 message: string documentation\_url: optional string source: optional object { pointer } pointer: optional string result: [Subscription](https://developers.cloudflare.com/api/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20subscription%20%3E%20%28schema%29) { id, currency, current\_period\_end, 5 more } id: optional string Subscription identifier tag. maxLength32 currency: optional string The monetary unit in which pricing information is displayed. current\_period\_end: optional string The end of the current period and also when the next billing is due. formatdate-time current\_period\_start: optional string When the current billing period started. May match initial\_period\_start if this is the first period. formatdate-time frequency: optional "weekly" or "monthly" or "quarterly" or "yearly" How often the subscription is renewed automatically. One of the following: "weekly" "monthly" "quarterly" "yearly" price: optional number The price of the subscription that will be billed, in US dollars. rate\_plan: optional [RatePlan](https://developers.cloudflare.com/api/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. id: optional "free" or "lite" or "pro" or 7 more The ID of the rate plan. One of the following: "free" "lite" "pro" "pro\_plus" "business" "enterprise" "partners\_free" "partners\_pro" "partners\_business" "partners\_enterprise" currency: optional string The currency applied to the rate plan subscription. externally\_managed: optional boolean Whether this rate plan is managed externally from Cloudflare. is\_contract: optional boolean Whether a rate plan is enterprise-based (or newly adopted term contract). public\_name: optional string The full name of the rate plan. scope: optional string The scope that this rate plan applies to. sets: optional array of string The list of sets this rate plan applies to. Returns array of strings. state: optional "Trial" or "Provisioned" or "Paid" or 4 more The state that the subscription is in. One of the following: "Trial" "Provisioned" "Paid" "AwaitingPayment" "Cancelled" "Failed" "Expired" success: true Whether the API call was successful ### Get Subscription HTTP HTTPHTTP TypeScriptTypeScript PythonPython GoGo TerraformTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/subscriptions/$SUBSCRIPTION_IDENTIFIER \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 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 } ```