Sign in
Auto Recharge

Set or update auto-recharge config for a customer

Persists the auto-recharge configuration for a customer. When no reusable card is on file, a Stripe SetupIntent client secret is returned so the caller can collect one.

put/v1/sdk/auto-recharge

Request body

currencystring required
customerEmailstring email
customerNamestring
customerRefstring required
deferSetupIntentboolean
enabledboolean required
maxMonthlySpendMajornumber
thresholdAmountMajornumber
topupAmountMajornumber
triggerType'balance' required

Response

Saved auto-recharge config and optional SetupIntent details.

publishableKeystring

Stripe publishable key for the resolved environment

setupClientSecretstring

Stripe SetupIntent client secret for card collection

stripeAccountIdstring

Connected Stripe account ID

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
  }
}

Changes

Changed in 3 of the 27 revisions of this API.156

  • e356f6586bf23See 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

  • bbc2ff2bc849125See the full diff
    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      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

  • a30b6aef464d1See 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