Create a Stripe Checkout link that starts a monthly plan when a person pays it; nothing is charged from this call

Creates a Stripe Checkout link for the first period of a monthly plan. Nothing is charged from here: a HUMAN pays on the Stripe page, the card is saved for the monthly renewals, and only then the monthly credit is added. exhaustionMode has no default and must be chosen: topup buys credit with the saved card once the monthly credit is used up (like auto top-up), cap buys nothing and caps the month at the plan price. A consumer account (no company ID, VAT ID or company name) gets no Checkout link: the call returns 409 subscription_confirmation_required with a confirmUrl to the form in the portal, where the person expressly asks to start the service before the 14-day withdrawal period ends, chooses the behaviour after exhaustion and pays; consumerConsent is no longer sent. The billing address is required. Supports Idempotency-Key.

post/v1/subscription/checkout

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/subscription/checkout
  • 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

tier'490' | '990' | '1990' required

Tier to start, written as a string: its monthly price in CZK excluding VAT. See GET /v1/subscription for the prices and the monthly credit of each tier.

exhaustionMode'topup' | 'cap' required

What happens once the monthly credit is used up. There is no default, choose deliberately: topup buys credit with the saved card (like auto top-up, with the account's usual limits), cap buys nothing and stops spending until the next renewal, so a month never costs more than the plan price.

consumerConsentboolean

Kept for compatibility, no longer needed. A consumer account (no company ID, VAT ID or company name) cannot start a plan through the API at all: the call returns 409 subscription_confirmation_required with a confirmUrl to the portal form, where the person makes the express request to start the service before the 14-day withdrawal period ends and pays. Business accounts omit this field.

Response

Checkout URL

checkoutUrlstring required

Changes

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