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. It is shown once.
- Copy the key and leave it on your clipboard.
Connect to Sprid
sprid connect paddle --app <slug> --key-from-clipboardUse your Sprid app slug. Add --env sandbox for a sandbox key.
Sprid reads the key from your clipboard, saves it and clears the clipboard, so it never shows on screen or lands in a file. Working with an agent? Tell it the key is copied and it runs this for you. Typing it yourself, copy the key last: paste the command into your terminal first, then copy the key, then press Enter. If the clipboard still holds the command, Sprid refuses it; copy the key and run it again. Without clipboard access (a remote shell), save the key to a file and pass --key <file> instead.
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.