Subscriptions

List an account's existing subscriptions

List existing subscription records for the required owner_id and owner_type (users or organizations). Requires permission to manage that account, including write access in an assistant connection's grant. Returns plan, status, recorded price, interval and subscription dates; include=subscribable embeds the owner. Use page and per_page, following meta.next_page. Reading this list does not start, renew or cancel subscriptions or charge a payment.

get/subscriptions

Request

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

Query parameters

owner_idstring required

Owner (subscribable) id to scope the subscriptions to.

owner_type'users' | 'organizations' required

Owner type. Send users or organizations.

pageinteger

Select within paginated results

per_pageinteger

Number results to return

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

Subscriptions for the requested owner. 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 2 revisions of this API.