Schema to update an existing checkout link.
Field | Type | Required | Description |
---|---|---|---|
metadata |
Dict[str, models.CheckoutLinkUpdateMetadata] | ➖ | 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 boolean You can store up to 50 key-value pairs. |
products |
List[str] | ➖ | List of products that will be available to select at checkout. |
label |
OptionalNullable[str] | ➖ | N/A |
allow_discount_codes |
OptionalNullable[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 |
OptionalNullable[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. |
success_url |
OptionalNullable[str] | ➖ | 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. |