Update subscription BETA
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_
Required
|
The ID for the subscription to update. |
| Name | Description |
|---|---|
subscription
|
The subscription object containing the current version, and fields to update.
Unset fields will be left at their current server values, and JSON |
Response Fields
| Name | Description |
|---|---|
errors
|
Information about errors encountered during the request. |
subscription
|
The modified |
Examples
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: 2021-01-21' \
-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": "2020-08-03T21:53:10Z",
"timezone": "America/Los_Angeles"
}
}