OpenMax
Free Trial

Apps API · Billing Credits

Billing Credits: 5 endpoints

← All groups

GET /api/v1/billing/agent-credit-caps

List agent credit caps (monthly and daily)

Scope: billing:usage:read · Called with: appToken · operationId: list-billing-agent-credit-caps

Required app scope: billing:usage:read.

Responses

GET /api/v1/billing/agents/{identity_id}/monthly-cap

Get an agent credit cap (monthly and daily)

Scope: billing:usage:read · Called with: appToken · operationId: get-billing-agent-credit-cap

Required app scope: billing:usage:read.

Parameters

Name In Type Required Description
identity_id path string (uuid) yes

Responses

GET /api/v1/billing/auto-topup-settings

Get auto top-up settings

Scope: billing:usage:read · Called with: appToken · operationId: get-billing-auto-topup-settings

Required app scope: billing:usage:read.

Returns the caller org's auto top-up configuration plus the deployment-level feature_enabled flag. Any org member. Response wrapped in standard envelope.

Responses

GET /api/v1/billing/balance-alert-settings

Get balance alert settings

Scope: billing:usage:read · Called with: appToken · operationId: get-billing-balance-alert-settings

Required app scope: billing:usage:read.

Returns the caller org's absolute credit-balance alert threshold. has_threshold=false means no absolute threshold is configured — the burn-rate tiers (7/3/1 days of projected runway) stay active regardless, as they are a system measurement rather than a preference. Any org member. Response wrapped in standard envelope.

Responses

GET /api/v1/billing/credit-grants

List credit grant batches

Scope: billing:usage:read · Called with: appToken · operationId: list-billing-credit-grants

Required app scope: billing:usage:read.

Lists every credit grant batch with source, original amount, current remaining amount, expiry, and lifecycle status. Page-based: increment page while pagination.has_more is true. Any org member. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page query integer (int32) Page number (1-based; default: 1)
page_size query integer (int32) Grant batches per page (default: 50, max: 100)
order_by query string Sorting is not supported yet; any non-empty value is rejected with 400

Responses