Skip to content

Latest commit

 

History

History
24 lines (20 loc) · 16.6 KB

checkoutlink.md

File metadata and controls

24 lines (20 loc) · 16.6 KB

CheckoutLink

Checkout link data.

Fields

Field Type Required Description Example
created_at date ✔️ Creation timestamp of the object.
modified_at date ✔️ Last modification timestamp of the object.
id str ✔️ The ID of the object.
metadata Dict[str, models.CheckoutLinkMetadata] ✔️ N/A
payment_processor models.PaymentProcessor ✔️ N/A
client_secret str ✔️ Client secret used to access the checkout link.
success_url Nullable[str] ✔️ URL where the customer will be redirected after a successful payment.
label Nullable[str] ✔️ Optional label to distinguish links internally
allow_discount_codes bool ✔️ 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.
require_billing_address bool ✔️ 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.
discount_id Nullable[str] ✔️ 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.
organization_id str ✔️ The organization ID. 1dbfc517-0bbf-4301-9ba8-555ca42b9737
products List[models.CheckoutLinkProduct] ✔️ N/A
discount Nullable[models.CheckoutLinkDiscount] ✔️ N/A
url str ✔️ N/A