Subsail Help Docs

Search...
K

Get subscription status

Get subscription status

Overview

Special endpoint for getting a subscription's status, useful when integrating Subsail with other systems. Does not require an API key.

gethttps://api.subsail.com/v1/subscriptions/{id}/status/

Request parameters

idstringRequired

path

Resource ID (alphanumeric).

Request body

No request body.

Request examples

No request body.

Responses

200Subscription status
statusSubscriptionStatusRequired

values

  • Active
  • Active - Renewals stopped
  • Complete
  • Cancelled
  • Past due

Example

JSON
{
  "status": "Active"
}
404Resource not found
errorbooleanRequired
messagestringRequired
codestring

Machine-readable code, e.g. read_only_key for read-only key write attempts.

Example

JSON
{
  "error": "<boolean>",
  "message": "<string>",
  "code": "<string>"
}

© Subsail Help Docs

Powered by Basedoc