Skip to content

GET /api/v1/billing

Operation: getBalances.

Balance summary (self/admin); spendable/held/pending/disputed/withdrawable separately, plus 30-day spend and active hold

GET https://amplerun-api.spiry.org/api/v1/billing

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.

NameLocationPresenceTypeDescription
assetqueryOptional“USDC” / “USDT”

Balances.

application/json

FieldTypePresenceDescription
spendable_microMicroAmountRequired
held_microMicroAmountRequired
pending_microMicroAmountRequired
disputed_microMicroAmountRequired
withdrawable_microMicroAmountRequired
spend_30d_microstringRequired
spend_window_fromRfc3339UtcRequired
spend_window_toRfc3339UtcRequired
active_hold_microMicroAmountRequired
confirming_microMicroAmountOptionalStablecoin 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_atRfc3339Utc or nullOptionalWhen 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"
}

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

FieldTypePresenceDescription
errorobjectRequired
{
"$ref": "#/components/schemas/ErrorEnvelope"
}

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.

Terminal window
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