Read what is being paid
Retrieve whether this account holds full access, how it holds it, what it is allowed against what it holds, the last payment, and the plans it may still take up.
There is no id in the URL: a token acts as one person, and one person has one account.
Nothing here is bought. Access moves only when Stripe confirms a payment, so a client that has just opened a checkout should read this again a moment later rather than assume anything.
This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.
Returns
A billing object. On a self hosted instance every ceiling is null, the payment is null, offers is empty and access_kind is null, because nothing is sold there.
What this account is paying, and what it is allowed.
Always billing. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
Everything the record holds.
Whether every ceiling but storage is lifted, however the account came to hold that: bought once, subscribed, or opened by us.
How full access is held: lifetime, subscription or granted, and null on the free plan. On a self hosted instance it is always null, because nothing is sold there.
When the subscription next bills, as a count of seconds since 1970. Null when nothing renews, which includes a subscription already on its way out.
The plan the subscription moves to at its next renewal, yearly after a move up, and null when no move is waiting. The move happens at renews_at, which is also when its price is first billed.
When a cancelled subscription stops, as a count of seconds. Null while it renews, and until that moment the cancellation can still be taken back.
When the one time purchase was ordered, as a count of seconds, null when it never was.
The one time purchase, null when nothing was ever ordered. A checkout nobody paid is not one, and an order that stopped holding stays here so that the end of access can be read.
The checkout session at Stripe the order was placed through.
The state in Stripe's own words: paid while it holds full access, then refunded or disputed once money went back.
Which plan was bought, read from the price, null once Stripe no longer knows that price. A paid order holds full access whatever the answer.
The price at Stripe the order was placed against, kept as it was at the sale.
When the checkout was opened, as a count of seconds.
When Stripe called the payment paid, as a count of seconds, null once the order no longer holds.
The address the invoices went to, null before anything was paid.
What the account is allowed. Null in any of these means no ceiling at all.
How many vaults may exist, null once full access is held.
How many contacts may exist across every vault, null once full access is held. Each vault owner and anybody still marked partial is left out of the count.
How many bytes of files may be held. Full access lifts this to the paid figure rather than removing it, and null means the instance meters nothing.
What the account holds right now, measured the same way the ceilings are.
How many vaults exist.
How many contacts the ceiling is measured against.
How many bytes of files are held.
The most recent payment, null when nothing was ever paid, which is what an account we opened access on looks like.
The id of the invoice at Stripe.
Which plan was paid for: monthly, yearly or lifetime. Read off the invoice rather than off the price it charged, and null when the catalogue no longer knows that price.
The state of the invoice, as Stripe names it.
What was paid, in the smallest unit of the currency, tax included.
The currency of that amount, three letters as Stripe writes them.
The number Stripe gave the invoice, null when it gave none.
When Stripe finalised the invoice, as a count of seconds.
Whether the catalogue could be read. False means Stripe did not answer and the list below is empty for that reason rather than because nothing is for sale.
What this account may still take up, shortest commitment first. Empty once it owns the product outright, and on a self hosted instance.
One plan.
The id of the price at Stripe. It is what you send to open a checkout, and it is the only handle on a plan: prices, names and currencies all live at Stripe.
monthly, yearly or lifetime. Every one of them unlocks exactly the same thing, so the kind says how often it bills and nothing else.
Whether taking it up starts a subscription. False is the one time purchase.
The price in the smallest unit of the currency below.
The currency Stripe quotes the plan in by default.
Every currency this plan is quoted in, the default one included. Send one of them as currency when you open a checkout.
One amount in one currency.
Three letters as Stripe writes them.
The price in the smallest unit of that currency.
Where to find this record.
The absolute address this record is read from.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.