Skip to main content
GET
GET
Returns the organisation’s active subscription details, including plan name, billing period, renewal date, and current scan credit usage.

Response

boolean
true on a successful request.
object
The active plan — name, slug, price, currency, recurrance (monthly/yearly).
string
Stripe subscription status: active, trialing, past_due, canceled, incomplete.
string
ISO 8601 date when the current billing period ends.
integer
Number of scan credits consumed in the current billing period.
integer
Total scan credits available in the current billing period.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

Subscription details