<- Subscriptions API

Subscriptions API

Pause subscriptionBeta

POST

 /v2/subscriptions/{subscription_id}/pause

Schedules a PAUSE action to pause an active subscription.

Permissions:CUSTOMERS_READ, INVOICES_WRITE, ITEMS_READ, ORDERS_WRITE, PAYMENTS_WRITE, SUBSCRIPTIONS_WRITE

Guide

Pause Subscriptions

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

subscription_id

string

Required

The ID of the subscription to pause.

Link to section

Request body

Link to section

pause_effective_date

string

The YYYY-MM-DD-formatted date when the scheduled PAUSE action takes place on the subscription.

When this date is unspecified or falls within the current billing cycle, the subscription is paused on the starting date of the next billing cycle.

Link to section

pause_cycle_duration

integer(64-bit)

The number of billing cycles the subscription will be paused before it is reactivated.

When this is set, a RESUME action is also scheduled to take place on the subscription at the end of the specified pause cycle duration. In this case, neither resume_effective_date nor resume_change_timing may be specified.

Link to section

resume_effective_date

string

The date when the subscription is reactivated by a scheduled RESUME action. This date must be at least one billing cycle ahead of pause_effective_date.

Link to section

resume_change_timing

string

The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to resume_effective_date.

Link to section

pause_reason

string

The user-provided reason to pause the subscription.

Max Length
255
Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

subscription

The subscription to be paused by the scheduled PAUSE action.

Link to section

actions

The list of a PAUSE action and a possible RESUME action created by the request.

Error descriptions