Sign in

v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB
Limits

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.

post/v1/sdk/limits

Request body

customerRefstring required
includeCheckoutSessionboolean
meterNamestring
productRefstring required
usageTypestring

Response

Limit check result

activationRequiredboolean

True when the customer must activate a priced default plan before usage is allowed

checkoutSessionIdstring

Checkout session ID if payment is required

checkoutUrlstring

Checkout URL if payment is required

confirmationUrlstring

Customer portal confirmation URL when activation is required (fallback when not starting checkout)

creditBalancenumber

Credit balance in mils (for pre-paid usage-based plans)

creditsPerUnitnumber

Credits per usage unit (for pre-paid usage-based plans)

currencystring

ISO 4217 currency code for credit fields

meterNamestring

The meter name to use when tracking usage events

remainingnumber required

Remaining usage units before hitting the limit

withinLimitsboolean required

Whether the customer is within their usage limits

Example response

{
  "checkoutSessionId": "e3f1c2d4b6a89f001122334455667788",
  "checkoutUrl": "https://solvapay.com/customer/checkout?id=e3f1c2d4b6a89f001122334455667788",
  "meterName": "requests",
  "plans": [
    {
      "pricingOptions": [
        {
          "basePrice": 1999,
          "currency": "USD",
          "default": true,
          "price": 2999,
          "setupFee": 500
        }
      ]
    }
  ],
  "remaining": 997,
  "withinLimits": true
}