<- Subscriptions API

Subscriptions API

Bulk swap planBeta

POST

 /v2/subscriptions/bulk-swap-plan

Schedules a plan variation change for all active subscriptions under a given plan variation.

Permissions:SUBSCRIPTIONS_WRITE, SUBSCRIPTIONS_READ, ITEMS_READ
Link to section

Request body

Example code

Link to section

new_plan_variation_id

string

Required

The ID of the new subscription plan variation.

This field is required.

Link to section

old_plan_variation_id

string

Required

The ID of the plan variation whose subscriptions should be swapped. Active subscriptions using this plan variation will be subscribed to the new plan variation on their next billing day.

Link to section

location_id

string

Required

The ID of the location to associate with the swapped subscriptions.

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

affected_subscriptions

integer(32-bit)

The number of affected subscriptions.

Error descriptions