Create a Stripe Checkout link that, when completed, immediately charges amountHal as the first top-up and saves the card for future auto top-ups (works even when a card is already saved); to change only the threshold without a charge, use PATCH /v1/credit/auto-topup instead

Creates a Stripe Checkout session whose completion IMMEDIATELY charges amountHal as the first top-up, and only that saves the card for future auto top-ups - works even with a card already saved from before. The only way to turn auto top-up on or change its amount; a threshold-only change with no charge is the PATCH above. The billing address is required. It is refused with subscription_cap_active while a monthly plan runs with the spending cap. Supports Idempotency-Key.

post/v1/credit/auto-topup/setup

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/credit/auto-topup/setup
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional key for one logical request. Its scope is global to this API key, independent of the HTTP method, path, or body: use a new value for every distinct logical action across all endpoints and request bodies, and reuse it only to retry the exact same logical request. Reusing a non-blank key within 24 hours returns the stored response; a concurrent request with the same key returns 409 idempotency_in_progress. A missing or whitespace-only value disables idempotency.

Request body

thresholdHalinteger required

Balance threshold that triggers an automatic top-up, in integer halere excluding VAT. Changing only this value does not charge the card.

amountHalinteger required

Credit added per automatic top-up, in integer halere excluding VAT. Completing setup charges this amount as the first top-up and saves the card.

Response

Checkout URL

checkoutUrlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.