Contents
Connecting to Paddle
PaddleSubs needs two things from each Paddle account: an API key, which lets your site read and change your catalog and customers in Paddle, and a client-side token, which lets the pages your visitors see show prices and open the checkout. Sandbox and live accounts have separate keys and tokens, and PaddleSubs keeps a separate pair for each.
Until you enter a key, opening PaddleSubs shows the Welcome to PaddleSubs page, which walks you through the steps below and the webhook setup in the section called “Setting Up Webhooks”, and lets you browse in offline mode in the meantime. See the section called “The Get Started Page”.
-
Sign in to your Paddle sandbox account at
sandbox-vendors.paddle.com(for a live account,vendors.paddle.com). -
Go to → → .
-
Create an API key. Give it a name that says which site uses it, such as
www.example.com, and give it read and write permission for products, prices, discounts, customers, transactions, subscriptions, adjustments and customer portal sessions. Copy the key: Paddle shows it only once. -
On the same page, create a client-side token and copy it.
-
Go to → and click in the toolbar of any PaddleSubs page.
-
On the Paddle Integrations tab, set Environment to Sandbox.
-
Paste the key into Sandbox API Key and the token into Sandbox client side token.
-
Click .
-
Open → → . If the page opens, PaddleSubs reached Paddle with your key. Any products you already have in Paddle are listed.
If the key is wrong, or your server can't reach Paddle, PaddleSubs shows a Paddle API unavailable page that says what Paddle answered and how to fix it. See the section called “When Paddle Can't Be Reached”.
Note
Products, prices, customers and Access Subscriptions belong to one environment. What you create while Environment is Sandbox stays in the sandbox and is hidden while it is Production, and the other way round. You don't need to delete your test data before going live.