Credits / GET

Get credits

Queries current tenant credits, accumulated usage, and balance composition.

Endpoints

Mobile only shows the endpoint list. View parameter details and examples on desktop.

MethodEndpointDescription

GET/api/v1/creditsQueries current tenant credits, accumulated usage, and balance composition.

GET/api/v1/credits

Tenant identity is determined by the API key and is not passed in the request body.

No required request parameters. Authentication is read from the Authorization header.

FieldTypeRequiredDescription

data.total_creditsnumberYesCurrent available total credits.

data.total_usagenumberYesAccumulated usage for the current tenant.

data.voucher_balancenumberYesVoucher balance.

data.cash_balancenumberYesCash balance.

data.credit_balancenumberYesCredit balance.

GET/api/v1/credits

curl "https://api.globalrouter.com/api/v1/credits" \
  -H "Authorization: Bearer $GR_API_KEY"

200 Response

{
  "data": {
    "total_credits": 48.5,
    "total_usage": 12.75,
    "voucher_balance": 8,
    "cash_balance": 40.5,
    "credit_balance": 0
  }
}