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

You are viewing an old version of the API
Resume subscription

POST /v2/subscriptions/{subscription_id}/resume

Schedules a RESUME action to resume a paused or a deactivated subscription.


Permissions
CUSTOMERS_READ
PAYMENTS_WRITE
SUBSCRIPTIONS_WRITE
ITEMS_READ
ORDERS_WRITE
INVOICES_WRITE
Guide
Deactivated Subscriptions
Try in API Explorer
Name Description
subscription_id
string

Required

The ID of the subscription to resume.

Name Description
resume_effective_date
string

Beta

The YYYY-MM-DD-formatted date when the subscription reactivated.

resume_change_timing
string

Beta

The timing to resume a subscription, relative to the specified resume_effective_date attribute value.

Response Fields

Name Description
errors
Error [ ]

Errors encountered during the request.

subscription
Subscription

The resumed subscription.

actions
SubscriptionAction [ ]

Beta

A list of RESUME actions created by the request and scheduled for the subscription.

Examples

You are viewing an old version of the API
POST /v2/subscriptions/{subscription_id}/resume
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/subscriptions/9ba40961-995a-4a3d-8c53-048c40cafc13/resume \
  -X POST \
  -H 'Square-Version: 2022-05-12' \
  -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": "18ff74f4-3da4-30c5-929f-7d6fca84f115",
      "type": "RESUME",
      "effective_date": "2022-01-01"
    }
  ]
}

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 CUSTOMER_MISSING_NAME

The provided customer does not have a recorded name.

>
400 Bad request CUSTOMER_MISSING_EMAIL

The provided customer does not have a recorded email.

>
400 Bad request INVALID_DATE

The subscription cannot be paused/resumed on the given date.

>
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"
    }
  ]
}