Swap planBeta

POST

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

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

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

Guide

Subscriptions Guide

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_id

string

Required

Read only The ID of the new subscription plan.

Min Length

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Show attributes

Link to section

subscription

The subscription with the updated subscription plan.

Show attributes

Link to section

actions

A list of a SWAP_PLAN action created by the request.

Show attributes

Link to section

Examples

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

curl https://connect.squareup.com/v2/subscriptions/9ba40961-995a-4a3d-8c53-048c40cafc13/swap-plan \
  -X POST \
  -H 'Square-Version: 2023-05-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response JSON

{
  "subscription": {
    "id": "9ba40961-995a-4a3d-8c53-048c40cafc13",
    "location_id": "S8GWD5R9QB376",
    "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
    "status": "ACTIVE",
    "price_override_money": {
      "amount": 2000,
      "currency": "USD"
    },
    "version": 1594311617331,
    "created_at": "2021-10-20T21:53:10Z",
    "timezone": "America/Los_Angeles",
    "source": {
      "name": "My App"
    }
  },
  "actions": [
    {
      "id": "f0a1dfdc-675b-3a14-a640-99f7ac1cee83",
      "type": "SWAP_PLAN",
      "effective_date": "2021-11-17",
      "new_plan_id": "DPNEOJAP33DKC3GAC5CAZG4O"
    }
  ]
}

Swap planBeta

Path parameters

Request body

Response fields

Error descriptions