• Billing API

Subscription

get

List all subscriptions

This endpoint retrieves a list of subscriptions

limitstring

The maximum number of subscriptions to return (default 20, maximum 100)

Pattern
^[0-9][0-9]?$|^100$
startingAfterstring

The ID of the last subscriptions in the previous page of results. Results will start after this subscription

Responses

Response examples

A list of subscriptions

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "id": "string",
        "paymentProfileId": "string",
        "network": "string",
        "billingThreshold": {
          "amount": 123.0,
          "currency": "string"
        },
        "billingStatus": "CANCELED",
        "currentPeriodEnd": "2023-06-07T17:32:28Z",
        "currentPeriodStart": "2023-06-07T17:32:28Z",
        "priceId": "string",
        "createdAt": "2023-06-07T17:32:28Z",
        "lastUpdatedAt": "2023-06-07T17:32:28Z"
      }
    ]
  }
}

Was this page helpful?