action square_list_subscription_events {
  label: "ListSubscriptionEvents"
  description: "Lists all events for a specific subscription.\nIn the current implementation, only `START_SUBSCRIPTION` and `STOP_SUBSCRIPTION` (when the subscription was canceled) events are returned."
  provider: square
  method: GET
  path: "/v2/subscriptions/{subscription_id}/events"
  encoding: json
  input: {
    type: "object"
    properties: {
      cursor: {
        type: "string"
      }
      limit: {
        type: "integer"
      }
      subscription_id: {
        type: "string"
      }
    }
    required: ["subscription_id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Defines the fields that are included in the response from the\n[ListSubscriptionEvents](https://developer.squareup.com/reference/square_2021-08-18/subscriptions-api/list-subscription-events)\nendpoint."
    properties: {
      cursor: {
        type: "string"
        description: "When a response is truncated, it includes a cursor that you can\nuse in a subsequent request to fetch the next set of events.\nIf empty, this is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
      }
      errors: {
        type: "array"
        description: "Information about errors encountered during the request."
        items: {
          type: "object"
          description: "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information."
          required: ["category", "code"]
          properties: {
            category: {
              type: "string"
              description: "The high-level category for the error."
            }
            code: {
              type: "string"
              description: "The specific code of the error."
            }
            detail: {
              type: "string"
              description: "A human-readable description of the error for debugging purposes."
            }
            field: {
              type: "string"
              description: "The name of the field provided in the original request (if any) that\nthe error pertains to."
            }
          }
        }
      }
      subscription_events: {
        type: "array"
        description: "The `SubscriptionEvents` retrieved."
        items: {
          type: "object"
          description: "Describes changes to subscription and billing states."
          required: ["id", "subscription_event_type", "effective_date", "plan_id"]
          properties: {
            effective_date: {
              type: "string"
              description: "The date, in YYYY-MM-DD format (for\nexample, 2013-01-15), when the subscription event went into effect."
            }
            id: {
              type: "string"
              description: "The ID of the subscription event."
            }
            info: {
              type: "object"
            }
            plan_id: {
              type: "string"
              description: "The ID of the subscription plan associated with the subscription."
            }
            subscription_event_type: {
              type: "string"
              description: "Type of the subscription event."
            }
          }
        }
      }
    }
  }
}