v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve balance

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

get/v1/balance

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'balance' required

String representing the object's type. Objects of the same type share the same value.