List subscriptions

Query subscriptions by player and optionally filter by status. Returns all matching subscriptions for the specified external_account_id.

GET
/sdk/subscriptions
Authorization<token>

Bearer token authentication for client-side SDK operations. Format: 'Authorization: Bearer '

In: header

Query Parameters

externalAccountId?string
status?string

Filter by status: "active", "past_due", "canceled", "expired"

Response Body

curl -X GET "https://test-api.stash.gg/sdk/subscriptions?externalAccountId=string&status=string"
{
  "subscriptions": [
    {
      "id": "string",
      "externalAccountId": "string",
      "planId": "string",
      "status": "string",
      "period": {
        "value": 0,
        "unit": "string"
      },
      "trialEnd": "2019-08-24T14:15:22Z",
      "accessEndDate": "2019-08-24T14:15:22Z",
      "currentPeriodEnd": "2019-08-24T14:15:22Z",
      "nextBillingDate": "2019-08-24T14:15:22Z",
      "cancelAtPeriodEnd": true,
      "canceledAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "checkoutLinkMetadata": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string",
      "property1": null,
      "property2": null
    }
  ]
}

How is this guide?