WoyraDocs
Get an API key

Current product subscription

GET/v1/subscriptions/{product}

Billing · Requires an API key

Returns the live subscription state for Woyra Mail or Email API. Requires billing:read.

Parameters

NameInDescription
productrequiredpath

Example

curl https://api.woyra.io/v1/subscriptions/<product> \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 Current subscription.

FieldTypeDescription
object"subscription"
idstring
productstring
planstring
statusstring
One of pending, active, past_due, cancelled, incomplete.
provider_customer_idstring
provider_subscription_idstring
current_period_endtimestamp

Errors

StatusCodes
404not_found, product_not_offered

Also in Billing