Stash Documentation
Integration GuidesAPI ReferenceWork with Us

Get subscription by ID

GET
/sdk/v1/subscriptions/{subscriptionId}

Authorization

Authorization<token>

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

In: header

Path Parameters

subscriptionIdstring

Query Parameters

segmentId?string

Response Body

curl -X GET "https://test-api.stash.gg/sdk/v1/subscriptions/string?segmentId=string"
{
  "subscriptionId": "string",
  "externalAccountId": "string",
  "segmentId": "string",
  "planId": "string",
  "status": "string",
  "lockedAmountCents": "string",
  "lockedCurrency": "string",
  "trialEnd": "2019-08-24T14:15:22Z",
  "accessEndDate": "2019-08-24T14:15:22Z",
  "currentPeriodStart": "2019-08-24T14:15:22Z",
  "currentPeriodEnd": "2019-08-24T14:15:22Z",
  "originalBillingDay": 0,
  "cancelAtPeriodEnd": true,
  "cancelledAt": "2019-08-24T14:15:22Z",
  "paymentMethodToken": "string",
  "lastPaymentAttempt": "2019-08-24T14:15:22Z",
  "gracePeriodEnd": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string",
      "property1": null,
      "property2": null
    }
  ]
}

How is this guide?