Update subscription

PUT

/v2/subscriptions/{subscription_id}

Updates a subscription by modifying or clearing subscription field values.

To clear a field, set its value to null.

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

Guide

Update Subscriptions

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

subscription_id

string

Required

The ID of the subscription to update.

Link to section

Request body

Link to section

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.

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

subscription

The updated subscription.

Link to section

Examples

PUT /v2/subscriptions/{subscription_id}

curl https://connect.squareup.com/v2/subscriptions/7217d8ca-1fee-4446-a9e5-8540b5d8c9bb \
  -X PUT \
  -H 'Square-Version: 2023-09-25' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscription": {
      "card_id": "{NEW CARD ID}",
      "canceled_date": null
    }
  }'

Response JSON

{
  "subscription": {
    "id": "7217d8ca-1fee-4446-a9e5-8540b5d8c9bb",
    "location_id": "LPJKHYR7WFDKN",
    "plan_variation_id": "XOUNEKCE6NSXQW5NTSQ73MMX",
    "customer_id": "AM69AB81FT4479YH9HGWS1HZY8",
    "start_date": "2023-01-30",
    "charged_through_date": "2023-03-13",
    "card_id": "{NEW CARD ID}",
    "status": "ACTIVE",
    "invoice_ids": [
      "inv:0-ChAPSfVYvNewckgf3x4iigN_ENMM",
      "inv:0-ChBQaCCLfjcm9WEUBGxvuydJENMM"
    ],
    "version": 3,
    "created_at": "2023-01-30T19:27:32Z",
    "timezone": "UTC",
    "source": {
      "name": "My Application"
    }
  }
}

Update subscription

Path parameters

Request body

Response fields

Error descriptions