Skip to main content
GET
/
api
/
v1
/
billing
/
balance
JavaScript
import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted
});

const response = await client.billing.getBalance();

console.log(response.balance);
{
  "balance": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  }
}

Authorizations

Authorization
string
header
required

Rye API key

Response

Balance in smallest currency unit and currency code

balance
object
required