Skip to content
Cloudflare API
Start here
API Reference
Zones

Subscriptions

Zone Subscription Details
GET/zones/{zone_id}/subscription
Create Zone Subscription
POST/zones/{zone_id}/subscription
Update Zone Subscription
PUT/zones/{zone_id}/subscription
ModelsExpand Collapse
SubscriptionGetResponse = object { 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 2 more

How often the subscription is renewed automatically.

One of the following:
"weekly"
"monthly"
"quarterly"
"yearly"
"not-applicable"
price: optional number

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

rate_plan: optional RatePlan { id, currency, externally_managed, 4 more }

The rate plan applied to the subscription.

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"
SubscriptionCreateResponse = object { 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 2 more

How often the subscription is renewed automatically.

One of the following:
"weekly"
"monthly"
"quarterly"
"yearly"
"not-applicable"
price: optional number

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

rate_plan: optional RatePlan { id, currency, externally_managed, 4 more }

The rate plan applied to the subscription.

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"
SubscriptionUpdateResponse = object { 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 2 more

How often the subscription is renewed automatically.

One of the following:
"weekly"
"monthly"
"quarterly"
"yearly"
"not-applicable"
price: optional number

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

rate_plan: optional RatePlan { id, currency, externally_managed, 4 more }

The rate plan applied to the subscription.

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"