Get billing info

Get billing configuration and balance for the authenticated developer

GET /api/v1/billing

Get billing info

cURL

curl --request GET \
  --url https://staging.api.rye.com/api/v1/billing \
  --header 'Authorization: <api-key>'

200

{
  "drawdown": {
    "balance": {
      "currencyCode": "USD",
      "amountSubunits": 1500
    },
    "config": {
      "chargeAutomatically": true,
      "currency": "USD",
      "minBalanceSubunits": 200000,
      "targetBalanceSubunits": 1000000
    },
    "enabled": true
  }
}

Authorizations

Authorization · string · header · required

Rye API key

Response

200

application/json

Billing configuration including drawdown settings and balance

drawdown · object · required

Show child attributes