Connect Polar to ShipVitals
Sales, Polar'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
- organizations:read
- Names the organization the token belongs to
- products:read
- Lists products to match to projects
- subscriptions:read
- Reads subscriptions for MRR
- orders:read
- Reads orders, Polar's fees and tax
- refunds:read
- Reads refunds
Read-only: ShipVitals can't change anything at Polar.
What ShipVitals keeps: A read-only organization token, encrypted; customer ids only as a one-way hash.
How to connect
- In Polar, open your organization's Settings → Developers.
- Choose New Token, name it ShipVitals, and pick an expiry.
- Tick only the read scopes listed below.
- Create it and copy the token. It starts with polar_oat_.
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
- Polar didn't accept the token. It may have expired: create a new organization access token and paste it.
- A permission is missing
- This token can't read everything ShipVitals needs. Create a token with the read scopes listed below.
- Access removed
- ShipVitals' access was removed in Polar. Connect it again; the history it brought in is kept.
- Rate-limited
- Polar asked ShipVitals to slow down. Nothing to do: the sync carries on by itself and catches up.
- Quota reached
- The account used up a Polar quota. The sync resumes when the quota resets.
- Not found
- Something the connection reads is gone from Polar: renamed, moved or removed. Review the connection's resources, or connect again.
- Polar is unavailable
- Polar is having trouble on its side. Check its status page; ShipVitals retries by itself.
- Couldn't reach Polar
- The request didn't get through. ShipVitals retries by itself; if it keeps failing, check that Polar is reachable.
- An answer ShipVitals didn't expect
- Polar 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
- A field in the connection doesn't work with Polar. Check it against How to connect, and test again.