Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Subscriptions

BulkSwapPlan

Schedules a plan variation change for all active subscriptions under a given plan variation. For more information, see Swap Subscription Plan Variations.

post/v2/subscriptions/bulk-swap-plan

Request body

new_plan_variation_idstring required

The ID of the new subscription plan variation.

This field is required.

old_plan_variation_idstring 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.

location_idstring required

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

Example request

{
  "location_id": "S8GWD5R9QB376",
  "new_plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7",
  "old_plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H"
}

Response

Success

affected_subscriptionsinteger

The number of affected subscriptions.

Example response

{
  "affected_subscriptions": 12
}