v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB
Auto Recharge

Get auto-recharge config for a customer

Returns the stored auto-recharge configuration (and display block) for the given customer, or a null config when none is set.

get/v1/sdk/auto-recharge

Query parameters

customerRefstring required

Response

Current auto-recharge config, if present.

Example response

{
  "config": {
    "enabled": true,
    "maxMonthlySpendMinor": 10000,
    "monthlySpendMinor": 4500,
    "monthlySpendPeriod": "2026-07",
    "topup": {
      "amountMinor": 2000,
      "currency": "USD",
      "mode": "fixed"
    },
    "trigger": {
      "thresholdAmountMinor": 500,
      "type": "balance"
    }
  },
  "display": {
    "currency": "USD",
    "exchangeRate": 1,
    "formatted": {
      "threshold": "$5.00",
      "topup": "$20.00"
    },
    "rateSource": "live",
    "thresholdAmountMajor": 5,
    "topupAmountMajor": 20
  }
}