Aggregation
Aggregation
How a metric combines matching events into one number:
count, sum, max, count_distinct, or sql.Allowance
Allowance
The amount of a feature a customer can use in a period, set by their plan or a grant.
Approval request
Approval request
A pending action that waits for a second person to approve or reject it. See Approvals.
Audit log
Audit log
A record of changes in the workspace, searchable and exportable. See Audit logs.
Auto top-up
Auto top-up
A rule that buys more credits when a balance falls to a threshold, up to a monthly cap.
Billing period
Billing period
The span of time a subscription’s usage and fees are billed together, such as a calendar month.
Cadence
Cadence
How often a price is charged:
monthly, quarterly, annual, one_time, or usage_based.Credit block
Credit block
A set of credits with its own amount, source, and expiry, held in a wallet.
Credit note
Credit note
A document that reduces what a customer owes against a paid invoice.
Credit type
Credit type
What a set of credits is for, such as
image_credits, and how the balance behaves at zero.Customer
Customer
The party you bill. Identified by your own ID, or by a generated
cust_… ID.Dunning
Dunning
The reminders and retries sent when an invoice isn’t paid.
Entitlement
Entitlement
Whether a customer can use a feature right now, and how much of it remains.
Event
Event
One record of something a customer did, sent by your application.
Idempotency key
Idempotency key
A value that makes a retried request count or create only once.
in_arrears / in_advance
in_arrears / in_advance
Whether a price is charged at the end (
in_arrears) or the start (in_advance) of a period.Invoice
Invoice
A bill for a period, a purchase, or a manual charge. See the lifecycle.
License
License
A seat a customer holds under a
license price.Metric
Metric
A rule that turns events into a billable quantity. See Metrics.
Plan
Plan
A named bundle of prices that customers subscribe to.
Portal session
Portal session
A short-lived, customer-scoped token that lets a customer’s browser read their billing. See Customer portal.
Price
Price
What to charge for a metric or a flat fee, with a pricing model. See Pricing models.
Sandbox
Sandbox
A workspace where payments never reach a real processor and test clocks are available. See Environments.
Subscription
Subscription
A customer’s enrolment in a plan from a start date.
Test clock
Test clock
A simulated time for a sandbox customer, moved forward to test billing. See Test billing.
Wallet
Wallet
A customer’s balance for one credit type.
Webhook
Webhook
A signed notification sent to your endpoint when something happens. See Webhooks.