Schema to update an existing checkout link.
| Field | Type | Required | Description |
|---|---|---|---|
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> | ➖ | 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 |
array<string> | ➖ | List of products that will be available to select at checkout. |
label |
?string | ➖ | N/A |
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. |
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. |
returnUrl |
?string | ➖ | When set, a back button will be shown in the checkout to return to this URL. |