Connect Paddle to ShipVitals
Sales, Paddle's fees, tax, refunds and MRR
BetaRead-only key · about 3 minutes
Beta: this connector is new in the beta, and we're still checking it against more accounts.
What it reads
- transaction.read
- Reads sales, fees and tax
- subscription.read
- Reads subscriptions for MRR
- adjustment.read
- Reads refunds and chargebacks
- product.read
- Lists products to match to projects
Read-only: ShipVitals can't change anything at Paddle.
What ShipVitals keeps: A read-only API key, encrypted; customer ids only as a one-way hash.
How to connect
- In Paddle, open Developer tools → Authentication.
- Choose New API key, and name it ShipVitals.
- Give it only the read permissions listed below, and nothing else.
- Save, and copy the key. It starts with pdl_live_apikey_.
About 3 minutes.
How to revoke
Removing the connection in ShipVitals deletes the stored key at once.
What it powers
Dashboard tabs: Revenue.
Sync
- Free: Daily
- Indie: Hourly
- Studio: Every 15 minutes
- Agency: Every 15 minutes
Troubleshooting
Each error a connection can hit, and its fix. The connection's health page names the one it hit.
- Access refused
- Paddle no longer accepts what ShipVitals signs in with. Create a new key, or connect again, and replace it in the connection.
- A permission is missing
- This key can't read everything ShipVitals needs. Edit the key in Paddle and add the read permissions listed below.
- Access removed
- ShipVitals' access was removed in Paddle. Connect it again; the history it brought in is kept.
- Rate-limited
- Paddle asked ShipVitals to slow down. Nothing to do: the sync carries on by itself and catches up.
- Quota reached
- The account used up a Paddle quota. The sync resumes when the quota resets.
- Not found
- Something the connection reads is gone from Paddle: renamed, moved or removed. Review the connection's resources, or connect again.
- Paddle is unavailable
- Paddle is having trouble on its side. Check its status page; ShipVitals retries by itself.
- Couldn't reach Paddle
- The request didn't get through. ShipVitals retries by itself; if it keeps failing, check that Paddle is reachable.
- An answer ShipVitals didn't expect
- Paddle answered in a shape ShipVitals didn't expect, usually after a change on its side. We're told, and the data you have is kept.
- A setting doesn't work
- This key won't do: a sandbox key shows test data as revenue, and a key with write permissions can change your account. Create a live key with only the read permissions listed below.