balances

Get the current user or organization account's balance

Deprecated. This path is the pre-/v2/ URL for /v2/customer/balance and is kept only so existing integrations keep working. It behaves identically, responds with a Sunset header, and stops being served on 2027-03-01. Move to /v2/customer/balance.

Get the current account's balance

get/v2/alpha/customer/balance

Response

Successful response

balanceCentsnumber required
maxOverdraftCentsnumber required

Changes

Changed in 3 of the 14 revisions of this API.4

    • ○

      api tag balances added

      api-tag-added

    • ○

      api operation id customer-getBalance removed and replaced with customer-getBalance-legacy

      api-operation-id-removed

    • ○

      endpoint deprecated

      endpoint-deprecated

    • ○

      added the required property to the response with the status

      response-required-property-added