• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Swap plan BETA

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
Name Description
subscription_id
string

Required

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

Name Description
new_plan_id
string

Required

Read only The ID of the new subscription plan.

Min Length 1

Response Fields

Name Description
errors
Error [ ]

Errors encountered during the request.

subscription
Subscription

The subscription with the updated subscription plan.

actions
SubscriptionAction [ ]

A list of a SWAP_PLAN action created by the request.

Examples

You are viewing an old version of the API
POST /v2/subscriptions/{subscription_id}/swap-plan
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/subscriptions/9ba40961-995a-4a3d-8c53-048c40cafc13/swap-plan \
  -X POST \
  -H 'Square-Version: 2022-09-21' \
  -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"
    }
  ]
}

Error Descriptions

400 Bad request CUSTOMER_NOT_FOUND

The provided customer id can't be found in the merchant's customers list.

>
403 Forbidden CARD_PROCESSING_NOT_ENABLED

The location provided in the API call is not enabled for credit card processing.

>
403 Forbidden
{
  "errors": [
    {
      "code": "CARD_PROCESSING_NOT_ENABLED",
      "category": "INVALID_REQUEST_ERROR"
    }
  ]
}