Skip to main content
GET
Read the balance

Authorizations

Authorization
string
header
required

Token <your API key>

Response

200 - application/json

Balance split by kind

balance_usd
number

Everything you can spend right now, in USD: signup_usd + bought_usd + manual_usd (permanent) + every temporary[].remaining_usd (temporary). datacircle_meta.credits_remaining on a provider call is this number after the call.

signup_usd
number

Permanent: what is left of the 5 USD signup credit every workspace gets once. Never expires. Spent after temporary credit, before bought and manual credit.

bought_usd
number

Permanent: what is left of the credit you bought through Stripe Checkout (POST /checkout/). Never expires. Spent after temporary and signup credit, together with manual credit, oldest first.

manual_usd
number

Permanent: what is left of credit Datacircle added to your workspace by hand (a refund, a gift, a deal). Never expires. Spent after temporary and signup credit, together with bought credit, oldest first. 0 for most workspaces.

temporary
object[]

Temporary credit: one entry per campaign grant that has not expired yet, soonest to expire first; empty when you have none. Spent before any permanent credit. At expires_at the entry leaves this list and whatever is left of it is gone.

coop_file_unlocked
boolean

true once this workspace may download the co-op file (coop): it spent 50 USD on credit in total (for the foreseeable future), or 3 people you invited signed up (GET /me/invites/). GET /files/ then shows it allowed. It says nothing about the 50M US dataset (us_50m), which only invites unlock.