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);
{
  "drawdownEnabled": true,
  "balance": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs-test.rye.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Rye API key

Response

Balance in smallest currency unit and currency code

drawdownEnabled
boolean
required
balance
object
required