Get checkout domain approval status using the API

What's new?

We added a new checkout domain entity to the Paddle API, along with four operations to list, get, delete, and verify payment methods for the domains approved to serve Paddle Checkout for your account.

List and get operations require the checkout_domain.read permission. Delete and verifying a payment method require checkout_domain.write.

How it works

Checkout domains are the domains that you've submitted for approval to serve Paddle Checkout for your account. Paddle reviews each domain before it can be used to load a checkout, so customers can only purchase from sites you control.

You can submit domains for approval from the dashboard. Now, you can use the API to track their approval status and manage them:

• List returns checkout domains for your account.
• Get returns a single checkout domain by ID.
• Delete removes a checkout domain. Deleted domains can no longer load checkouts for your account.
• Verify a payment method starts payment method verification for an approved domain. Currently supports Apple Pay.

Checkout domain entities include the domain name, its approval status, and the Apple Pay verification status under payment_method_verification.apple_pay.

Next steps

This change is available in version 1 of the Paddle API.

These are new endpoints. There are no breaking changes to existing integrations. Existing API keys don't inherit the new checkout domains permissions, so you'll need to update them.

Make sure your API key has the relevant permission, then call any of the /checkout-domains endpoints to inspect or manage your approved domains.