Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 11.3 KB

checkoutlinkupdate.md

File metadata and controls

23 lines (17 loc) · 11.3 KB

CheckoutLinkUpdate

Schema to update an existing checkout link.

Example Usage

import { CheckoutLinkUpdate } from "@polar-sh/sdk/models/components/checkoutlinkupdate.js";

let value: CheckoutLinkUpdate = {};

Fields

Field Type Required Description
metadata Record<string, components.CheckoutLinkUpdateMetadata> Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters.
The value must be either:

* A string with a maximum length of 500 characters
* An integer
* A floating-point number
* A boolean

You can store up to 50 key-value pairs.
products string[] List of products that will be available to select at checkout.
label string N/A
allowDiscountCodes boolean Whether to allow the customer to apply discount codes. If you apply a discount through discount_id, it'll still be applied, but the customer won't be able to change it.
requireBillingAddress boolean Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.
discountId string ID of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.
successUrl string URL where the customer will be redirected after a successful payment.You can add the checkout_id={CHECKOUT_ID} query parameter to retrieve the checkout session id.