For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Paddle Docs home

Update checkout URL settings

Updates the checkout URL settings for your account.

PATCH/settings/checkout-url

Updates the checkout URL settings for your account.

Pass null to clear default_url.

Returns a checkout_url_domain_not_approved error if the URL's domain isn't an approved checkout domain for your account.

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

Requires checkout_settings.write permission.

Request body

default_urlstring (uri) | null

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

Must use https, and its domain must 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.

Length: 1–1000
Pattern: ^https://[^\s]+$

Response (200)

dataobjectrequired
Represents the checkout URL settings for your account.
default_urlstring (uri) | nullrequired

URL that Paddle opens when a checkout is created without a URL of its own. null until set.

Must use https, and its domain must 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.

Length: 1–1000
Pattern: ^https://[^\s]+$
metaobjectrequired
Information about this response.
request_idstringrequired
Example: b15ec92e-8688-40d4-a04d-f44cbec93355
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Request
{
  "default_url": "https://example.com/checkout"
}
Response
{
  "data": {
    "default_url": "https://example.com/checkout"
  },
  "meta": {
    "request_id": "7b8c9d0e-1f2a-4b3c-9d4e-5f6a7b8c9d0e"
  }
}

Was this page helpful?