Create Subscription

post/subscriptions

Request

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

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

Created. The first subscription for an owner that has not used its free trial starts in trialing; otherwise it starts active.

Example response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.