Checkout Template Object


A checkout template can be shared with customers to create checkouts with predefined information already included.

Properties
idstringRead-onlyformat GUID

Checkout template ID.


statusstring
3 enum supported values:
UNKNOWN_STATUSACTIVEINACTIVE

Status of the checkout template.

When status is INACTIVE checkouts will not be created with this template id. Instead, the endpoint will redirect to the domain site.

Default: ACTIVE


customizationobject

Custom settings to apply to the checkout page created from this template.


lineItemsArray <LineItem>maxItems 300

Line items.

Max: 300 items


couponCodestring

Coupon code.

Note that a checkout can only hold one couponCode at a time. If an additional couponCode is added, it will override the existing couponCode. For additional information, see the Coupons API.

Was this helpful?
Yes
No