Checkio API
put/{tenantId}/v1/billing/topup-config

Save auto-topup configuration

Requires Authentication
Billing
Payments

Upserts the auto-topup configuration. Saving resets the failure

counter and clears auto_disabled_at, so a "fix card + save" flow

re-enables an auto-disabled config without a separate call.

Path Parameters

NameTypeDescription
tenantId
required
string (uuid)Tenant UUID

Request Body

required
enabled
boolean
thresholdCredits
integer (int64)
required
- Wallet balance (in credits) below which the auto-topup fires.
topupAmountCredits
integer (int64)
required
- Credits to add on each trigger. Bounded server-side by the auto-topup limits (£20-£5000 ex-VAT in the default config).
paymentMethodId
string (uuid)
required
- Must reference an active method belonging to this tenant.
cooldownSeconds
integer
required
- Minimum seconds between consecutive auto-topups.

Responses

Saved

Response Bodyapplication/json
tenantId
string (uuid)
enabled
boolean
thresholdCredits
integer (int64)
topupAmountCredits
integer (int64)
paymentMethodId
string (uuid)
cooldownSeconds
integer
lastAutoTopupAt
string (date-time)
consecutiveFailures
integer
autoDisabledAt
string (date-time)
autoDisabledReason
string
updatedAt
string (date-time)

Code Examples

curl -X PUT 'https://api-next.checkio.co.uk/{tenantId}/v1/billing/topup-config' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "enabled": true,
  "thresholdCredits": 0,
  "topupAmountCredits": 0,
  "paymentMethodId": "00000000-0000-0000-0000-000000000000",
  "cooldownSeconds": 0
}'