Prepare a purchase for a person: quote, contract versions, steps and the confirmation URL

Open, no API key. Creates nothing: no order, no account, no trial. Only a person can place the order, locale follows the same rule as assessFit: any well-formed tag, fallback 'de' for languages without a published website; the response field locale is the language used for the checkout link. by opening human_confirmation_url in a browser. human_confirmation_url is null for white_label (no self-service) and when checkout is not live for the language; use registration_url then. The confirmation link covers the plan; additional assistants and seats are bought after sign-up. Rate limit 60 requests per minute per IP.

post/api/agents/prepare-checkout

Request

  • Base URL: https://smartwebchat.eu
  • URL: https://smartwebchat.eu/api/agents/prepare-checkout
  • Auth: HTTP bearer

Request body

plan'business' | 'agency' | 'white_label' required

Plan to quote. 'white_label' returns price 'custom' without a calculation.

additional_assistantsinteger

Additional assistants beyond the plan's included number (integer, 0 or more).

additional_seatsinteger

Additional team seats beyond the plan's included number (integer, 0 or more).

expected_messages_per_monthinteger

Expected messages per month; overage above the included quota is priced per 1,000 messages.

localestring

Language tag, e.g. 'en', 'fr-CA', 'it'. Any well-formed tag is accepted; languages without a published website fall back to 'de'. The response field locale names the language actually used.

Response

The preparation

schema_version'1.0'
kind'self_service' | 'not_self_service'
plan'business' | 'agency' | 'white_label'
localestring

Language actually used for the links (fallback de)

prepared_atstring date-time
quoteobject

Same contract as quotePlan

stepsstring[]
human_confirmation_urlstring uri nullable
confirmation_unavailable_reason'checkout_not_live' | 'no_self_service' | 'null' nullable
registration_urlstring uri
order_notestring nullable

Changes

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