Check usage limits for a customer and product
Checks whether a customer has an active purchase for a product and is within their usage limits. Returns a checkout URL if payment is required.
Authorizations
Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.
Body
Response
Limit check result
Remaining usage units before hitting the limit. -1 means unlimited (no finite cap).
997
Whether the customer is within their usage limits
true
True when the customer must activate a priced default plan before usage is allowed
Prepaid usage balance context when the default plan is usage-based
Checkout session ID if payment is required
"e3f1c2d4b6a89f001122334455667788"
Checkout URL if payment is required
"https://solvapay.com/customer/checkout?id=e3f1c2d4b6a89f001122334455667788"
Customer portal confirmation URL when activation is required (fallback when not starting checkout)
Credit balance in credits (100 credits = 1 minor currency unit), for pre-paid usage-based plans
Credits per usage unit (for pre-paid usage-based plans)
ISO 4217 currency code for credit fields
The meter name to use when tracking usage events
"requests"
Access is blocked pending an auto-recharge top-up of the prepaid balance — onExceed: top_up.
Access is blocked pending a plan switch to the limit's target pricing — onExceed: auto_upgrade.
Access is granted and usage beyond the included cap accrues an overage charge — onExceed: charge.
Active plans on the product available for activation or checkout
Product the limit check applies to
Access is granted but the caller should degrade/throttle service — the limit was exceeded with onExceed: throttle.
The customer was auto-upgraded to the target pricing to restore access — onExceed: auto_upgrade succeeded.