Skip to main content
GET
Read the balance

Authorizations

Authorization
string
header
required

Your API key: Authorization: Bearer <your API key>. Authorization: Token <your API key> works too.

Response

200 - application/json

Balance split by kind

balance_usd
number

Everything you can spend right now, in dollars: signup_credit_usd + funds_usd + manual_credit_usd (permanent) + every temporary_credits[].credit_usd (temporary). datacircle_meta.balance_usd on a provider call is this number after the call.

signup_credit_usd
number

Permanent: what is left of the $5 signup credit every workspace gets once. Never expires.

funds_usd
number

Permanent: what is left of the funds you added through Stripe Checkout (POST /checkout/). Never expires.

manual_credit_usd
number

Permanent: what is left of the credits Datacircle added to your workspace by hand (a refund, a gift, a deal). Never expires. 0 for most workspaces.

temporary_credits
object[]

Temporary credits: one entry per campaign grant that has not expired yet, soonest to expire first. Empty when you have none. At expires_at the entry leaves this list and whatever is left of it is gone.