<- Subscriptions API

Subscriptions API

All versions ->

Swap planBeta

POST

 /v2/subscriptions/{subscription_id}/swap-plan

Schedules a SWAP_PLAN action to swap a subscription plan variation in an existing subscription.

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

Guide

Swap Subscription Plan Variations

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

subscription_id

string

Required

The ID of the subscription to swap the subscription plan for.

Link to section

Request body

Link to section

new_plan_variation_id

string

The ID of the new subscription plan variation.

This field is required.

Link to section

phases

A list of PhaseInputs, to pass phase-specific information used in the swap.

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

subscription

The subscription with the updated subscription plan.

Link to section

actions

A list of a SWAP_PLAN action created by the request.

Error descriptions