subscription

Returns the caller's active subscription.

get/api/subscription

Request

  • Base URL: https://api.pricklymails.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pricklymails.com/api/subscription
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Response

The caller's active subscription (a Free plan if never subscribed).

billing_cyclestring required

Billing cycle ("monthly" or "yearly").

external_idstring nullable

Identifier of the subscription at the payment provider, null when there is none.

has_accessboolean required

Whether the subscription provides access to the service.

monthly_creditsinteger required

Tokens granted each month by the plan.

period_endstring date-time required

End of the current billing period.

period_startstring date-time required

Start of the current billing period.

planstring required

Plan code: "free", "starter", "pro", "business" or "enterprise".

statusstring required

Subscription status: "trial", "active", "past_due", "canceled", "expired" or "paused".

trial_days_remaininginteger nullable

Days remaining in a trial period. null when not in trial.

Changes

No recorded changes to this operation across all 1 revision of this API.