bulk-swap-plan-request.md

Bulk Swap Plan Request

Defines input parameters in a call to the BulkSwapPlan endpoint.

Structure

Bulk Swap Plan Request

Fields

Name	Type	Tags	Description
new_plan_variation_id	str	Required	The ID of the new subscription plan variation. This field is required. Constraints: Minimum Length: 1
old_plan_variation_id	str	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. Constraints: Minimum Length: 1
location_id	str	Required	The ID of the location to associate with the swapped subscriptions. Constraints: Minimum Length: 1

Example (as JSON)

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