What's new?
You can now set up and check your Paddle account using the Paddle API, without logging in to the Paddle dashboard.
Get and update account settings like your default payment link, checkout payment methods, tax settings, and balance currency. Check your verification status, create client-side tokens, check that your checkout domains are approved, and look up the countries and currencies that Paddle supports.
AI agents connected to the Paddle MCP server can do all of this too, so you can ask an agent to set up checkout, check your account configuration, or tell you whether your account is ready to go live.
How it works
API root
The API root returns details about the credentials that you're using, including which account you're authenticated against, whether you're working in sandbox or live, and the permissions that you have. Use it to check an API key or an MCP connection before you make other requests.
It doesn't require any permissions. A request with a key that isn't valid fails with a 403 error, and a request with no API key succeeds but doesn't include an account.
Account
Account operations return the business identity of the account that you're authenticated as, including its Paddle ID, legal name, display name, website, and contact email. Use them to check the business details that appear on invoices and other documents, or to update your contact email.
Getting your account requires the account.read permission, and updating it requires account.write. You can only update the contact email. To change anything else, contact Paddle support.
Settings
Settings operations let you get and update account-level settings for checkout, tax, and currencies. Use them to set up checkout and tax without the dashboard, or to check your configuration before you go live.
Each setting has its own read and write permissions, except checkout settings, which share checkout_settings.read and checkout_settings.write.
| Path | What it controls | Permissions |
|---|---|---|
/settings/tax | The default tax mode for prices with a tax_mode of account_setting. | tax_settings.read, tax_settings.write |
/settings/balance-currency | The currency that your balance is held in and paid out from. | balance_currency.read, balance_currency.write |
/settings/currency-conversions | The currencies that Paddle automatically converts prices into for customers. | currency_conversion.read, currency_conversion.write |
/settings/statement-descriptor | The name that appears on customer bank and card statements. | statement_descriptor.read, statement_descriptor.write |
/settings/checkout-url | Your default payment link. | checkout_settings.read, checkout_settings.write |
/settings/checkout-payment-methods | The payment methods that are turned on at checkout. | checkout_settings.read, checkout_settings.write |
/settings/checkout-features | Discount codes, the marketing consent checkbox, and saved payment methods at checkout. | checkout_settings.read, checkout_settings.write |
/settings/checkout-styles-overlay | The brand color used by overlay checkout. | checkout_settings.read, checkout_settings.write |
/settings/checkout-recovery | The email that Paddle sends when a customer abandons a checkout, and the discount that it offers. | checkout_settings.read, checkout_settings.write |
In live accounts, your default payment link must be on an approved domain. Submit domains for approval in the Paddle dashboard, then use checkout domains to check that a domain is approved before you set it. In sandbox, the domain doesn't need to be approved.
Verifications
Verifications show whether an account is ready for live payments, and which steps still need to be completed. Use them to check whether you can go live: list verifications with verification_type=onboarding, then check the status:
completedmeans the account is ready.action_requiredmeans there's something to complete in the Paddle dashboard.
Verifications are read-only, only apply to live accounts, and require the verification.read permission.
Countries and currencies
Countries and currencies return reference data about the countries that Paddle knows about and the currencies that Paddle supports. Use them to populate country and currency pickers, validate addresses, and check the minimum charge before you create a price.
They describe what Paddle supports, not what's turned on for your account, so they don't require any permissions.
Configure your account from your AI tools
The Paddle MCP server and Paddle agent skills pick up the new operations, so you can ask an agent to check and configure your account without leaving your editor. For example:
- "Is my Paddle account ready to accept live payments, and what's outstanding?"
- "Set my default payment link to my checkout page."
- "Which payment methods are turned on for checkout, and what's my default tax mode?"
Updating settings requires write permissions, like checkout_settings.write. A live MCP server connected with OAuth starts with read access, so grant write access before you ask an agent to change settings.
If a request returns a forbidden error, your agent can get the API root to see which permissions it has, then tell you which one to add to your API key or MCP connection. You can also make the change in the Paddle dashboard.
Settings on a live account affect real checkouts, so review each change before you let an agent make it.
Next steps
This change is available in version 1 of the Paddle API.
These are new operations, so it's a non-breaking change, meaning it doesn't impact existing integrations.
Existing API keys don't inherit the new permissions. To use the account, settings, and verification operations, add the permissions that you need to your API key. The API root, countries, and currencies operations don't need any permissions.
To get started, work through the go-live checklist. It shows how to complete each step in the Paddle dashboard or using the API. For the full reference, see the API root, account, settings, verifications, countries, and currencies overviews.
Summary of changes
API root
OperationCheck which account you're authenticated against, whether you're working in sandbox or live, and the permissions you have.
Account
OperationGet the business identity of the account that you're authenticated as.
Update the contact email for your account.
Settings
OperationGet tax settings for your account, including the default tax mode for prices.
Update tax settings for your account.
Get the currency that your balance is held in and paid out from.
Update your preferred balance currency.
Get the currencies that Paddle automatically converts prices into.
Turn automatic price conversion on or off for currencies.
Get the name that appears on customer bank and card statements.
Update the name that appears on customer bank and card statements.
Get your default payment link.
Set or clear your default payment link.
Get the payment methods that are available on your account and enabled at checkout.
Turn payment methods on or off at checkout.
Get whether discount codes, the marketing consent checkbox, and saved payment methods are turned on at checkout.
Turn discount codes, the marketing consent checkbox, and saved payment methods on or off at checkout.
Get the brand color used by overlay checkout.
Update the brand color used by overlay checkout.
Get checkout recovery settings, including the discount offered in recovery emails.
Turn checkout recovery emails on or off, and set the discount that they offer.
Verifications
OperationList verifications for your account, so you can check whether it's ready for live payments.
Get a verification using its ID.
Countries
OperationList the countries that Paddle knows about, including whether Paddle supports sales there.
Currencies
OperationList the currencies that Paddle supports, including the decimal places used and the minimum charge.
API keys
FeatureNew permission required to get your account.
New permission required to update your account.
New permission required to get tax settings.
New permission required to update tax settings.
New permission required to get your balance currency.
New permission required to update your balance currency.
New permission required to get currency conversion settings.
New permission required to update currency conversion settings.
New permission required to get your statement descriptor.
New permission required to update your statement descriptor.
New permission required to get your default payment link, checkout payment methods, checkout features, overlay checkout styles, and checkout recovery settings.
New permission required to update your default payment link, checkout payment methods, checkout features, overlay checkout styles, and checkout recovery settings.
New permission required to list or get verifications.