PApaddlehq
Settings

Update checkout URL settings

Changed on

Updates the checkout URL settings for your account.

Pass null to clear default_url.

In live accounts, the URL's domain must be an approved checkout domain for your account, or the request returns a checkout_url_domain_not_approved error. Sandbox accounts accept any https URL.

If successful, your response includes a copy of the updated checkout URL settings entity.

patch/settings/checkout-url

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Request body

default_urlstring uri nullable

URL that Paddle opens when a checkout is created without a URL of its own. Pass null to clear it.

Must use https. In live accounts, its domain must also be an approved checkout domain for your account.

Paddle appends ?_ptxn= and the transaction ID to this URL. The page must have Paddle.js set up to read it and open the checkout.

Response

The request has succeeded.

Example response

{
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes