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": "db",
    "thresholdAmountMajor": 5,
    "topupAmountMajor": 20
  },
  "validation": {
    "maxAmountMajor": 10000,
    "stripeMinimumMinorByCurrency": {
      "GBP": 30,
      "USD": 50
    }
  }
}

Changes

Changed in 4 of the 27 revisions of this API.146

Aug 13, 2026e356f6586bf23See the full diff
- ●
  added the new db enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new fallback enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new parity enum value to the / response property for the response status
  response-property-enum-value-added
Jul 30, 20268578b7536a9f1See the full diff
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 17, 2026bbc2ff2bc849114See the full diff
- ▲
  removed the required property ///// from the response with the status
  response-required-property-removed
- ●
  removed the optional property ///// from the response with the status
  response-optional-property-removed
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  removed the completed enum value from the ///// response property for the response status
  response-property-enum-value-removed
- ○
  added the required property ///// to the response with the status
  response-required-property-added
Jul 4, 2026a30b6aef464d1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history