Connect Stripe to ShipVitals
Revenue, refunds, fees and MRR
AvailableRead-only key · about 3 minutes
What it reads
- Balance (Read)
- Reads balance
- Balance transaction sources (Read)
- Reads balance transaction sources
- Charges (Read)
- Reads charges
- Customers (Read)
- Reads customers
- Disputes (Read)
- Reads disputes
- Events (Read)
- Reads events
- Invoices (Read)
- Reads invoices
- Payouts (Read)
- Reads payouts
- Prices (Read)
- Reads prices
- Products (Read)
- Reads products
- Subscriptions (Read)
- Reads subscriptions
- Connected accounts (Read)
- Only for Connect platforms
Read-only: ShipVitals can't change anything at Stripe.
What ShipVitals keeps: A restricted, read-only key, encrypted; customer ids only as a one-way hash.
How to connect
- Open Developers → API keys in the Stripe Dashboard.
- Choose Create restricted key, and name it ShipVitals.
- Set each permission listed below to Read, and leave the rest at None.
- Create the key and copy it. It starts with rk_live_.
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
- Stripe 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 Stripe and add Read access for the permissions listed below.
- Access removed
- ShipVitals' access was removed in Stripe. Connect it again; the history it brought in is kept.
- Rate-limited
- Stripe asked ShipVitals to slow down. Nothing to do: the sync carries on by itself and catches up.
- Quota reached
- The account used up a Stripe quota. The sync resumes when the quota resets.
- Not found
- Something the connection reads is gone from Stripe: renamed, moved or removed. Review the connection's resources, or connect again.
- Stripe is unavailable
- Stripe is having trouble on its side. Check its status page; ShipVitals retries by itself.
- Couldn't reach Stripe
- The request didn't get through. ShipVitals retries by itself; if it keeps failing, check that Stripe is reachable.
- An answer ShipVitals didn't expect
- Stripe 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 isn't a live restricted key. A secret key can change your account and a test-mode key shows test data as revenue: create a restricted key with Read access in live mode.