POpolar
checkout-links
public

Update Checkout Link

Changed on

Update a checkout link.

Scopes: checkout_links:write

patch/v1/checkout-links/{id}

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/checkout-links/{id}
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: checkout_links:write)
    • or HTTP bearer
    • or HTTP bearer

Path parameters

idstring uuid4 required

The checkout link ID.

Request body

trial_interval'day' | 'week' | 'month' | 'year'
trial_interval_countinteger nullable

The number of interval units for the trial period.

metadataobject

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.

productsstring[] nullable

List of products that will be available to select at checkout.

labelstring nullable
allow_discount_codesboolean nullable

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.

require_billing_addressboolean nullable

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.

discount_idstring uuid4 nullable

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.

seatsinteger nullable

Preconfigured number of seats for seat-based pricing. When set, checkout sessions created from this link are locked to this number of seats and the customer won't be able to change it. All products on the link must use seat-based pricing and allow this number of seats. If the products no longer accommodate this value when the link is opened, it'll be ignored.

success_urlstring uri nullable

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.

return_urlstring uri nullable

When set, a back button will be shown in the checkout to return to this URL.

Response

Checkout link updated.

idstring uuid4 required

The ID of the object.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

trial_interval'day' | 'week' | 'month' | 'year' required
trial_interval_countinteger nullable required

The number of interval units for the trial period.

metadataMetadataOutputType required
payment_processor'stripe' required
client_secretstring required

Client secret used to access the checkout link.

success_urlstring nullable required

URL where the customer will be redirected after a successful payment.

return_urlstring nullable required

When set, a back button will be shown in the checkout to return to this URL.

labelstring nullable required

Optional label to distinguish links internally

allow_discount_codesboolean required

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.

require_billing_addressboolean required

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.

discount_idstring uuid4 nullable required

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.

seatsinteger nullable required

Preconfigured number of seats for seat-based pricing. When set, checkout sessions created from this link are locked to this number of seats and the customer won't be able to change it. All products on the link must use seat-based pricing and allow this number of seats. If the products no longer accommodate this value when the link is opened, it'll be ignored.

organization_idstring uuid4 required

The organization ID.

urlstring required

Changes

  • 8ae937367e87Revision changes
    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status