Subscriptions

Get an existing subscription record by ID

Retrieve an existing subscription by its PurpleGrain subscription ID. Returns its plan, status, recorded price and interval, service limit, trial and billing-period dates, and start or cancellation dates. Use include=subscribable to embed the owning user or organization. Requires permission to manage that owner, including write access in an assistant connection's grant. Reading the record does not start, renew or cancel a subscription or charge a payment.

get/subscriptions/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/subscriptions/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:subscribable

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; max 10 paths. Allowed paths: subscribable.

Response

Successful. When the include query parameter is used, the response may contain an included array (JSON:API) or inlined related resources (application/json).

Example response

{
  "data": {
    "type": "subscription",
    "interval": "month"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.