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
CreatedAt time.Time ✔️ Creation timestamp of the object.
ModifiedAt time.Time ✔️ Last modification timestamp of the object.
ID string ✔️ The ID of the object.
Metadata map[string]components.CheckoutLinkMetadata ✔️ N/A
PaymentProcessor components.PaymentProcessor ✔️ N/A
ClientSecret string ✔️ Client secret used to access the checkout link.
SuccessURL string ✔️ URL where the customer will be redirected after a successful payment.
Label string ✔️ Optional label to distinguish links internally
AllowDiscountCodes 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.
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.
OrganizationID string ✔️ The organization ID. 1dbfc517-0bbf-4301-9ba8-555ca42b9737
Products []components.CheckoutLinkProduct ✔️ N/A
Discount components.CheckoutLinkDiscount ✔️ N/A
ProductID string ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
ProductPriceID string ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
Product components.CheckoutLinkProduct ✔️ Product data for a checkout link.
ProductPrice components.CheckoutLinkProductPrice ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
URL string ✔️ N/A