List Subscription Events - Automate.ax

square.listSubscriptionEvents lists all events for a specific subscription.

Example

automations/square-list-subscription-events.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("List Square Subscription Events", () => {
  onDashboardRun({ title: "List Square Subscription Events" })

  square.listSubscriptionEvents({
    subscriptionId: "subscription_id",
    cursor: "cursor",
    limit: 1,
  })
})

Inputs

Every input accepts a compatible signal. It requires SUBSCRIPTIONS_READ.

Field	Type	Required	Default	Description
`subscriptionId`	`string`	Yes	—	The ID of the subscription to retrieve the events for.
`cursor`	`string \| null`	No	—	When the total number of resulting subscription events exceeds the limit of a paged response, specify the cursor returned from a preceding response here to fetch the next set of results. If the cursor is unset, the response contains the last page of the results. For more information, see Pagination.
`limit`	`number \| null`	No	—	The upper limit on the number of subscription events to return in a paged response.

Use the official ListSubscriptionEvents reference for provider field semantics and limits.

Output

Returns the official Square.ListSubscriptionEventsResponse response as a codec-safe object. Square integer money amounts remain bigint values.