CheckoutSession
Attributes
id string required Checkout session ID (cs_ prefix)
title string Checkout page title (defaults to store name)
description string Checkout page description (null unless explicitly set)
checkout_url uri required Hosted checkout page URL — redirect your customer here (format uri)
pay_redirect_url uri required Secure payment page URL (format uri)
No description.
amount integer required Subtotal in cents
discount_amount integer required Discount in cents
tax_amount integer required Tax in cents
total_amount integer required Total in cents
coupon object No description.
items array of LineItem required No description.
display object Custom field definitions
metadata object No description.
return_url string No description.
cancel_url string No description.
expires_at integer required Session expiration timestamp (Unix ms)
CheckoutSession
{ "id": "string", "title": "string", "description": "string", "checkout_url": "string", "pay_redirect_url": "string", "merchant": { "id": "string", "name": "string", "handle": "string", "slug": "string", "logo": "string", "favicon": "string", "accentColor": "string", "primaryColor": "string", "statementDescriptor": "string", "supportEmail": "string" }, "amount": 0, "discount_amount": 0, "tax_amount": 0, "total_amount": 0, "coupon": { "code": "string", "discount_amount": 0 }, "items": [ { "name": "string", "amount": 0, "quantity": 0, "image": "string" } ], "display": {}, "metadata": {}, "return_url": "string", "cancel_url": "string", "expires_at": 0}