<- Subscriptions API

Subscriptions API

Resume subscription

POST

 /v2/subscriptions/{subscription_id}/resume

Schedules a RESUME action to resume a paused or a deactivated subscription.

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

Guide

Deactivated 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 resume.

Link to section

Request body

Link to section

resume_effective_date

string

Beta

The YYYY-MM-DD-formatted date when the subscription reactivated.

Link to section

resume_change_timing

string

Beta

The timing to resume a subscription, relative to the specified resume_effective_date attribute value.

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

subscription

The resumed subscription.

Link to section

actions

Beta

A list of RESUME actions created by the request and scheduled for the subscription.

Error descriptions