Checkout link data.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
string | ✔️ | The ID of the object. | |
createdAt |
\DateTime | ✔️ | Creation timestamp of the object. | |
modifiedAt |
\DateTime | ✔️ | Last modification timestamp of the object. | |
trialInterval |
Components\TrialInterval | ✔️ | The interval unit for the trial period. | |
trialIntervalCount |
int | ✔️ | The number of interval units for the trial period. | |
metadata |
array<string, string|int|float|bool> | ✔️ | 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. | |
returnUrl |
string | ✔️ | When set, a back button will be shown in the checkout to return to this URL. | |
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. |
|
requireBillingAddress |
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. | |
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 |
array<Components\CheckoutLinkProduct> | ✔️ | N/A | |
discount |
Components\DiscountFixedOnceForeverDurationBase|Components\DiscountFixedRepeatDurationBase|Components\DiscountPercentageOnceForeverDurationBase|Components\DiscountPercentageRepeatDurationBase | ✔️ | N/A | |
url |
string | ✔️ | N/A |