<- Subscriptions API

Subscriptions API

All versions ->

Cancel subscription

POST

 /v2/subscriptions/{subscription_id}/cancel

Schedules a CANCEL action to cancel an active subscription.

This sets the canceled_date field to the end of the active billing period. After this date, the subscription status changes from ACTIVE to CANCELED.

Permissions:SUBSCRIPTIONS_WRITE

Guide

Cancel 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 cancel.

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

subscription

The specified subscription scheduled for cancellation according to the action created by the request.

Link to section

actions

Beta

A list of a single CANCEL action scheduled for the subscription.