Skip to main content
GET
/
billing
/
api
/
v1
/
billing
/
resolver
/
{organization_id}
Get resolver billing summary
curl --request GET \
  --url https://www.closient.com/billing/api/v1/billing/resolver/{organization_id} \
  --header 'X-API-Key: <api-key>'
{
  "usage": {},
  "limits": {},
  "estimated_monthly_bill": {}
}

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

200 - application/json

OK

Resolver subscription tier, status, usage, and estimated next bill.

Returned by GET /billing/resolver/{organization_id}. The usage block is the canonical billing-and-enforcement count (same numbers the Stripe invoice.upcoming hook sees, same numbers tier enforcement uses for Free-tier gating). On BUSINESS / EARLY_ADOPTER tiers, estimated_monthly_bill is computed via the same path that produces actual invoices, so the displayed estimate cannot drift from what the customer is billed.

tier
enum<string>
required

Subscription plan. FREE (Starter) is the default for every new organization; BUSINESS is the paid tier reached via POST /billing/resolver/checkout; EARLY_ADOPTER is the hidden $0-platform-fee tier assigned manually.

Available options:
FREE,
BUSINESS,
EARLY_ADOPTER
status
enum<string>
required

Lifecycle status. ACTIVE and GRACE allow full resolver use; LAPSED blocks new resolution-rule creation but keeps existing rules resolving; CANCELLED is the terminal state.

Available options:
ACTIVE,
GRACE,
LAPSED,
CANCELLED
usage
Usage · object
required

Billable counts for the current period. Keys: active_gtins (resolvable products), active_lots (GS1 AI 10 lot codes with resolver_enabled), active_serials (GS1 AI 21 serials), and active_epcis_events (EPCIS events captured this period). Each count reflects only resources where resolver_enabled is true (with parent cascade for lots and serials).

limits
Limits · object

Per-dimension hard caps for the Free tier. Always populated on tier == 'FREE' (keys: max_gtins, max_lots, max_serials, max_epcis_events); null on paid tiers (which are usage-priced instead of capped).

estimated_monthly_bill
Estimated Monthly Bill · object

Estimated next monthly invoice. null on Free tier. On paid tiers, keys are platform_fee (recurring license fee), usage_fee (graduated metered usage), total (sum, also what Stripe will draft next), and currency (ISO 4217). All decimal amounts are strings.