Credits API
Retrieve credit balances and pool breakdowns for your organization.
The Credits API allows you to check your organization's available credit balance, pool allocation, and expiration details.
Get Credit Balance
GET /api/v1/creditsRequest Headers
| Header | Type | Description |
|---|---|---|
Authorization | string | Bearer mst_live_... (Required) |
Example Request
curl -X GET https://mostly.so/api/v1/credits \
-H "Authorization: Bearer mst_live_abc123..."Example Response (200 OK)
{
"organizationId": "org_e7a89b4f-1234-5678-90ab-cdef12345678",
"organizationName": "Acme Media Studio",
"totalAvailable": 1250,
"breakdown": {
"SUBSCRIPTION": 1000,
"GRANT": 250,
"PURCHASE": 0,
"VOUCHER": 0
}
}Response Fields
| Field | Type | Description |
|---|---|---|
organizationId | string | Unique identifier of the authenticated organization. |
organizationName | string | Display name of the organization. |
totalAvailable | number | Total number of usable credits across all active non-expired pools. |
breakdown | object | Granular breakdown of credits by source pool (SUBSCRIPTION, GRANT, PURCHASE, VOUCHER). |