Skip to main content
GET
Credits consumed vs the allowance

Authorizations

Authorization
string
header
required

Your secret key (pep_sk_…) from Settings → API. Keys are org-scoped; treat them like passwords.

Query Parameters

period
enum<string>
Available options:
current,
30d,
all

Response

Usage for the period.

object
string
required
Allowed value: "usage"
period
enum<string>
required
Available options:
current,
30d,
all
trial
boolean
required

On the trial plan (no paid subscription).

trial_granted
boolean
required

The trial allowance exists (100 lifetime credits). A trial-plan org without a grant has allowance 0 and must pick a plan.

trial_ends_at
string<date-time> | null
required

When the 30-day trial window closes; null while the clock has not started (operator-provisioned orgs start it when the owner claims the org).

subscription
object | null
required

The paid subscription's lifecycle as Stripe last reported it; null on the trial plan.

credits
object
required
conversations
object
required
pages
object
required
documents
object
required
rates
object
required

Credits per conversation, page and document.