Update a checkout session
Updates a checkout session.
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Path Parameters
The id identifier.
Body
The description of the checkout session. This will be displayed to the customer.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
The payment method types allowed for this checkout session.
1autogiro, bacs_debit, card, card_present, bank_transfer, direct_transfer, gbp_credit_transfer, pay_by_bank, sepa_debit Response
Returns an updated checkout session object if a valid identifier was provided.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
checkout_session The time at which the checkout session was completed.
Configuration for collecting consent during the checkout session.
Custom text to display on the checkout session.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
gbp, usd, eur, sek "gbp"
The customer the checkout session is for.
The default payment method selected during the checkout session.
The description of the checkout session. This will be displayed to the customer.
The payment method types allowed for this checkout session.
The URL to return to after the checkout session is complete.
The status of the checkout session.
canceled, expired, open, complete The subscription data used to create the subscription on checkout completion.
The subscription created by the checkout session, if any.
The hosted URL of the checkout session.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Information about the merchant operating the checkout session.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.