Skip to navigation

Finalize a checkout

Charges the cart at version and applies it to the subscription. The version is claimed before the billing provider is called, so of two concurrent finalizes only one charges. The cart is priced once more first: a blocking problem refuses the purchase with 400 and the fresh problems list, and a checkout priced before a sibling completed is refused with 409. The claim is not released when the charge fails, so read the checkout before trying again. When the charge needs the customer, as with 3-D Secure, the response carries confirm_payment_intent_client_secret to confirm with Stripe.

Authentication

X-Schematic-Api-Keystring

A temporary access token in the X-Schematic-Api-Key header. Your server mints it with POST /temporary-access-tokens on the secret-key API for a company, optionally for one of its users, and hands it to the page. The token fixes the company every request reads and writes.

Path parameters

checkout_idstringRequired

checkout_id

Headers

X-Checkout-Session-IDstringOptional
The session from the preview or update that priced this cart. Omitted, the purchase starts a session of its own.

Request

This endpoint expects an object.
versionlongRequired

Response

OK
dataobject
paramsobject
Input parameters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error