Skip to content

Latest commit

 

History

History
27 lines (23 loc) · 17 KB

checkoutlink.md

File metadata and controls

27 lines (23 loc) · 17 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.
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
product_id str ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
product_price_id str ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
product models.CheckoutLinkProduct ✔️ Product data for a checkout link.
product_price models.CheckoutLinkProductPrice ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
url str ✔️ N/A