Açıklamalar İngilizce
Get subscriptions of API key owner
Returns the key owner's subscriptions together with the remaining token balance and the models each plan unlocks.
This is the primary way to answer "how much generation do I have left" before submitting a large job.
Subscriptions do not auto-renew: an expired one simply stops working, and a new one is purchased through the web interface.
Required key permission: billing.read.
Bu sayfada(2)
Olası yanıtlar
200Success. The payload is in data.
Success. The payload is in data.
{
"success": true,
"message": "Success",
"data": {
"available_models": [
"gpt-4.1-mini",
"claude-haiku-4.5"
],
"subscriptions": [
{
"id": 301,
"status": "active",
"current_period_start": "2026-07-15T00:00:00+00:00",
"current_period_end": "2026-08-15T00:00:00+00:00",
"items": [
{
"plan": {
"code": "creator",
"name": "Creator"
},
"status": "active",
"is_usable": true,
"billing_period": "monthly",
"start_at": "2026-07-15T00:00:00+00:00",
"end_at": "2026-08-15T00:00:00+00:00",
"token_allowance": 30000,
"tokens_used": 8200,
"tokens_remaining": 21800
}
]
}
]
}
}Success flag. Branch on the HTTP status code instead: any 2xx response carries true here, while an error comes back in a different shape that need not contain this field at all.
A human-readable note in the account language. Fine to show to a user; do not parse it — the wording changes without notice and is not an error code.
datazorunluThe response payload.
object
The response payload.
Codes of the models your active subscriptions grant. A model outside this list is rejected when creating an order.
subscriptionszorunluYour subscriptions. An empty list means there is no active subscription: orders are then possible only with a positive LMC balance.
array<object>
Your subscriptions. An empty list means there is no active subscription: orders are then possible only with a positive LMC balance.
Subscription identifier.
Subscription state. There is no auto-renewal: once the term ends the subscription expires and the plan has to be purchased again.
Start of the current period, ISO 8601.
End of the current period, ISO 8601 — the moment the subscription expires.
itemszorunluThe plans inside the subscription: what was purchased and how many tokens are left.
array<object>
The plans inside the subscription: what was purchased and how many tokens are left.
planzorunluThe purchased plan: code and name.
object
The purchased plan: code and name.
Plan code.
Display name of the plan.
State of the plan within the subscription.
Whether this plan can be spent right now. Branch on this, not on status: a plan can be formally active yet already exhausted.
Billing period. Only monthly is supported.
When the plan took effect, ISO 8601.
When the plan expires, ISO 8601. Any remaining tokens are forfeited after that moment.
How many tokens the plan grants per period.
How many tokens have been consumed in the current period.
How many tokens are left. This balance is spent before any LMC is charged — a top-up kicks in only once it runs out.
401The key is missing, unknown, disabled or expired.
The key is missing, unknown, disabled or expired.
{
"success": false,
"message": "API key is missing. Provide it in the X-API-KEY header.",
"data": null
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
Always null when the request is rejected before processing.
403The key lacks the required permission, or the object belongs to another user.
The key lacks the required permission, or the object belongs to another user.
{
"success": false,
"message": "This API key does not have permission to perform this action."
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
İlgili içerik
Düz anlatımla
Daha fazla
Bu sayfayı yapay zekâya verin
spesifikasyon 0.0.1