• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Subscription updated BETA

EVENT subscription.updated

Published when a Subscription is updated. Typically the subscription.status is updated as subscriptions become active or cancelled.


Permissions
SUBSCRIPTIONS_READ
Name Description
merchant_id
string

The ID of the target merchant associated with the event.

type
string

The type of event this represents, "subscription.updated".

event_id
string

A unique ID for the webhook event.

created_at
string

Read only Timestamp of when the webhook event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

data
SubscriptionUpdatedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "VSE65BA53PXCC",
  "type": "subscription.updated",
  "event_id": "c0b40cc0-7cb2-4aa1-81ce-0893b9b0b9b8",
  "created_at": "2020-07-15T05:14:11.213Z",
  "data": {
    "type": "subscription",
    "id": "592b9720-d2ef-4ee4-b3fd-9d98e4f829d2",
    "object": {
      "subscription": {
        "id": "592b9720-d2ef-4ee4-b3fd-9d98e4f829d2",
        "created_date": "2020-07-15",
        "customer_id": "QX2XG9GMQS2BVBJKPG8CJ8JKCR",
        "location_id": "EZHGJ7SNVAJ19",
        "plan_id": "CRUUZUK5W6PIIM6H54242NV6",
        "start_date": "2020-07-15",
        "status": "ACTIVE",
        "tax_percentage": "5",
        "timezone": "America/New_York",
        "version": 1594790050754
      }
    }
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?