Skip to content
Start here

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 = array of unknown