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

You are viewing an old version of the API
Update subscription

PUT /v2/subscriptions/{subscription_id}

Updates a subscription.

You can set, modify, and clear the subscription field values.


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

Name Description
subscription
Subscription

The subscription object containing the current version, and fields to update. Unset fields will be left at their current server values, and JSON null values will be treated as a request to clear the relevant data.

Response Fields

Name Description
errors
Error [ ]

Errors encountered during the request.

subscription
Subscription

The updated subscription.

Examples

You are viewing an old version of the API
PUT /v2/subscriptions/{subscription_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/subscriptions/9ba40961-995a-4a3d-8c53-048c40cafc13 \
  -X PUT \
  -H 'Square-Version: 2022-11-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscription": {
      "version": 1594155459464,
      "tax_percentage": null,
      "price_override_money": {
        "amount": 2000,
        "currency": "USD"
      }
    }
  }'
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"
    }
  }
}

Error Descriptions

400 Bad request CUSTOMER_NOT_FOUND

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

>
400 Bad request
{
  "errors": [
    {
      "code": "CUSTOMER_NOT_FOUND",
      "category": "INVALID_REQUEST_ERROR"
    }
  ]
}