Subscriptions

List Subscriptions

GET/{accounts_or_zones}/{account_or_zone_id}/subscriptions

Get Subscription

GET/accounts/{account_id}/subscriptions/{subscription_identifier}

Create Subscription

POST/{accounts_or_zones}/{account_or_zone_id}/subscriptions

Update Subscription

PUT/accounts/{account_id}/subscriptions/{subscription_identifier}

Delete Subscription

DELETE/accounts/{account_id}/subscriptions/{subscription_identifier}

Cancel Delayed Downgrade

POST/accounts/{account_id}/subscriptions/cancel-downgrade

ModelsExpand Collapse

SubscriptionDeleteResponse object { subscription_id }

subscription_id: optional string

Subscription identifier tag.

maxLength32

SubscriptionCancelDowngradeResponse = unknown or string

One of the following:

unknown

string

SubscriptionsCancel Reason

Create Cancel Reason

POST/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason

Get Cancel Reason

GET/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason

ModelsExpand Collapse

CancelReasonCreateResponse object { id, other, reason_code, 2 more }

id: optional string

The cancel reason identifier.

other: optional string

Additional cancellation details.

reason_code: optional array of string

The cancellation reason codes.

submitted: optional string

When the cancel reason was submitted.

formatdate-time

subscription_id: optional string

The subscription identifier.

CancelReasonGetResponse object { id, other, reason_code, 2 more }

id: optional string

The cancel reason identifier.

other: optional string

Additional cancellation details.

reason_code: optional array of string

The cancellation reason codes.

submitted: optional string

When the cancel reason was submitted.

formatdate-time

subscription_id: optional string

The subscription identifier.

SubscriptionsActions

Append Subscription Action

POST/accounts/{account_id}/subscriptions/{subscription_identifier}/action/append

SubscriptionsBulk

Create Subscriptions

POST/accounts/{account_id}/bulk/subscriptions

ModelsExpand Collapse

BulkCreateResponse object { client_secrets, subscriptions }

client_secrets: optional array of string

subscriptions: optional array of Subscription { 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 { 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"