Subscriptions

Subscription

put/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.

Request body

Response

Updated. Setting status to cancelled stamps cancelled_at. 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.