Paddle Billing
Search

Set your default payment link

Your default payment link is a quick way to open Paddle Checkout for a transaction. Set it in your Dashboard.

Transactions created by Paddle have a checkout payment link that you can use to open a checkout to collect for payment. Set a default payment link to tell Paddle which page in your app or website that checkout payment links should point to by default.

You can pass any of your other approved domains as checkout.url when creating or updating a transaction to override the default checkout link, if you'd like to point to another page.

You must set your default payment link to start selling with Paddle. You can't create transactions without it — including manually-collected transactions (invoices).

How it works

Every Paddle account has a default payment link. Paddle uses it to create unique payment links against transactions that automatically open a Paddle Checkout to collect for payment.

All automatically-collected transactions include a checkout payment link.

Manually-collected transactions don't include a checkout payment link by default, but you can set billing_details.enable_checkout to true when creating or updating to include one. When enabled, this link is automatically included on invoice documents sent by Paddle.

Checkout payment links are returned in transaction responses as checkout.url. They're made up of your default payment link with a _ptxn query parameter appended. The value of the query parameter is the transaction ID. For example:

In this example:

Default payment linkhttps://magnificent-entremet-7ae0c6.netlify.app/pay
Query parameter key?_ptxn=
Query parameter value (transaction ID)txn_01h2b0qpjc0xt8k5aw6nsdec4p

Your default payment link should be a page that includes Paddle.js. You don't need to do anything to get Paddle.js to open a checkout, it automatically opens a checkout for the transaction when the query parameter is present.

Before you begin

If you're working with the live environment, you must get your default payment link domain approved.

Build your default payment link page

Your default payment link should be a page that includes Paddle.js. It might be your checkout page, or you might create a separate page specifically for it.

If your page calls Paddle.Checkout.open() on load with a list of items or a transactionId, this takes priority over the query parameter.

By default, Paddle.js opens an overlay checkout for the passed transaction. You can set default checkout settings by passing them to Paddle.Setup(). Paddle.js uses default settings when opening a checkout payment link.

Set your default payment link

You can set your default payment link in your Paddle Dashboard.

Your sandbox and live systems are separate. You should set a default payment link for both systems. They don't have to be the same.

  • Go to Paddle > Checkout > Checkout Settings.

  • Add your default payment link under the "Default payment link" heading. This should be a complete link, like https://paddle.com/payment.

  • Click Save changes when you're done.

Screenshot of the checkout settings page in Paddle. It shows the general tab, which has sections for marketing consent, checkout discounts, statement description, and default checkout link. The default checkout link section is called out, and there's a sample link in the text box.

If you're working with the live environment, you must get your default payment link domain approved.

Related pages