Subscriptions

Zone Subscription Details

client.zones.subscriptions.get(, ?): SubscriptionGetResponse { id, currency, current_period_end, 5 more }

GET/zones/{zone_id}/subscription

Create Zone Subscription

client.zones.subscriptions.create(, ?): SubscriptionCreateResponse { id, currency, current_period_end, 5 more }

POST/zones/{zone_id}/subscription

Update Zone Subscription

client.zones.subscriptions.update(, ?): SubscriptionUpdateResponse { 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 { 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 { 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 { 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"