Before you start
Paddle Billing access (Paddle Classic keys do not work), and whether the key is for your live account or sandbox.
Set it up
- Developer tools → Authentication → New API key, named
Sprid. - Select transaction.read and subscription.read only.
- Create the key and save it to a private file such as
~/keys/paddle-sprid.txt. It is shown once.
Connect to Sprid
sprid connect paddle --app <slug> --key ~/keys/paddle-sprid.txtUse your Sprid app slug and your own file path. Add --env sandbox for a sandbox key.
Check the connection
Ask your agent: “Check that Sprid can read this Paddle account’s completed sales and active subscriptions.” A saved key alone does not confirm access.
What the numbers mean
Revenue covers 28 complete days of gross completed transactions: tax included, before refunds, credits, chargebacks and Paddle’s fees, so it will exceed your payout. MRR is current active subscription prices over their billing periods. Currencies stay separate; incomplete pagination makes a total unavailable.
If something goes wrong
- Access denied: a sandbox key needs
--env sandbox. - A permission is missing: create a replacement key with both permissions, then reconnect.
- Revenue exceeds your payout: expected. Compare against customer payments, not what is left after tax and fees.
Investigate with this connection
Reads transactions and subscriptions for the key’s merchant account, live or sandbox as saved. Amounts are minor-unit strings. Subscription creation-date filters apply per page, so keep paginating past pages with no matches.
sprid marketing-review capabilities --app <slug> --source paddle --jsonSee connected queries.
Sources and verification
Prefer your terminal? sprid docs paddle reads this same guide.