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

You are viewing an old version of the API
List subscription events BETA

GET /v2/subscriptions/{subscription_id}/events

Lists all events for a specific subscription.

In the current implementation, only START_SUBSCRIPTION and STOP_SUBSCRIPTION (when the subscription was canceled) events are returned.


Permissions
SUBSCRIPTIONS_READ
Guide
Subscriptions Guide
Try in API Explorer
Name Description
subscription_id
string

Required

The ID of the subscription to retrieve the events for.

Name Description
cursor
string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.

For more information, see Pagination.

limit
integer

The upper limit on the number of subscription events to return in the response.

Default: 200

Response Fields

Name Description
errors
Error [ ]

Information about errors encountered during the request.

subscription_events
SubscriptionEvent [ ]

The SubscriptionEvents retrieved.

cursor
string

When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of events. If empty, this is the final response.

For more information, see Pagination.

Examples

You are viewing an old version of the API
GET /v2/subscriptions/{subscription_id}/events
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/subscriptions/subscription_id0/events \
  -H 'Square-Version: 2021-01-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "subscription_events": [
    {
      "id": "06809161-3867-4598-8269-8aea5be4f9de",
      "subscription_event_type": "START_SUBSCRIPTION",
      "effective_date": "2020-04-24",
      "plan_id": "6JHXF3B2CW3YKHDV4XEM674H"
    },
    {
      "id": "a0c08083-5db0-4800-85c7-d398de4fbb6e",
      "subscription_event_type": "STOP_SUBSCRIPTION",
      "effective_date": "2020-05-06",
      "plan_id": "6JHXF3B2CW3YKHDV4XEM674H"
    }
  ]
}

Share Feedback

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