GET /api/v1/billing
Operation: getBalances.
Balance summary (self/admin); spendable/held/pending/disputed/withdrawable separately, plus 30-day spend and active hold
Endpoint
Section titled “Endpoint”GET https://amplerun-api.spiry.org/api/v1/billing
Authentication
Section titled “Authentication”Use the credential and scope required by this operation. For programmatic renter/host calls: Authorization: Bearer $AMPLERUN_API_KEY. A host-agent signature or other specialized proof is required where the description specifies it.
Parameters
Section titled “Parameters”| Name | Location | Presence | Type | Description |
|---|---|---|---|---|
asset | query | Optional | “USDC” / “USDT” |
Responses
Section titled “Responses”Balances.
application/json
| Field | Type | Presence | Description |
|---|---|---|---|
spendable_micro | MicroAmount | Required | |
held_micro | MicroAmount | Required | |
pending_micro | MicroAmount | Required | |
disputed_micro | MicroAmount | Required | |
withdrawable_micro | MicroAmount | Required | |
spend_30d_micro | string | Required | |
spend_window_from | Rfc3339Utc | Required | |
spend_window_to | Rfc3339Utc | Required | |
active_hold_micro | MicroAmount | Required | |
confirming_micro | MicroAmount | Optional | Stablecoin deposits credited before chain finality. Already in spendable_micro (usable for rentals), not yet in withdrawable_micro; they become withdrawable once final, or are reversed if the chain drops them. |
confirming_ready_at | Rfc3339Utc or null | Optional | When the last confirming deposit should be final (the chain’s typical finality lag); null when none is confirming. An estimate, not a promise. |
{ "$ref": "#/components/schemas/BalanceSet"}default
Section titled “default”Error envelope. 401 unauthenticated, 403/404 forbidden, 409 conflict, 422 invalid input, 429 rate limited (code UNAVAILABLE, retryable:true, no Retry-After header), 503 unavailable money/provider state with retryable:true.
application/json
| Field | Type | Presence | Description |
|---|---|---|---|
error | object | Required |
{ "$ref": "#/components/schemas/ErrorEnvelope"}Static request outline
Section titled “Static request outline”Replace path/query placeholders and provide the required JSON body, headers and credential from the sections above. This is a request outline, not a command that chooses an amount or starts a rental for you.
curl --request GET 'https://amplerun-api.spiry.org/api/v1/billing' \ --header "Authorization: Bearer $AMPLERUN_API_KEY"Schema definitions · Download OpenAPI · Authentication · Errors and recovery
Official AmpleRun documentation · Contract v3 · Generated from the API contract · Revision 52fe29de · Open AmpleRun · View Markdown · For agents