Skip to main content
GET
Billing Status
Base URL: https://api.nozle.app/engine/api/v1. Get the plan of a customer’s active subscription. If the customer has several active subscriptions, Nozle uses the one that started most recently. Auth: secret key only. Publishable keys are always rejected.
string
required
External customer ID derived by the trusted merchant backend.

Response

string
required
Plan code of the active subscription.
string
required
The plan’s display name. Falls back to the plan code when the plan has no name.
string
required
Always active. Only active subscriptions are read.
string
required
The plan’s billing interval: weekly, monthly, yearly, quarterly or semiannual.
integer
required
The plan’s base amount, in the currency’s smallest unit.
string
required
The plan’s currency.

Errors

Also available as GET /subscriptions/current (alias).
Your customers’ status has only the fields above. Usage fields such as events_used and mrr_tracked_usd_cents appear only in Nozle’s status of your own workspace on its Nozle plan. See Plan status fields.