Skip to main content
POST
/
v1
/
sdk
/
limits
Check usage limits for a customer and product
curl --request POST \
  --url https://api.example.com/v1/sdk/limits \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerRef": "<string>",
  "productRef": "<string>",
  "planRef": "<string>",
  "meterName": "<string>",
  "usageType": "<string>"
}
'
{
  "withinLimits": true,
  "remaining": 997,
  "checkoutSessionId": "e3f1c2d4b6a89f001122334455667788",
  "checkoutUrl": "https://solvapay.com/customer/checkout?id=e3f1c2d4b6a89f001122334455667788",
  "meterName": "requests",
  "creditBalance": 123,
  "creditsPerUnit": 123,
  "currency": "<string>",
  "activationRequired": true,
  "plans": [
    {
      "reference": "<string>",
      "type": "<string>",
      "price": 123,
      "currency": "<string>",
      "requiresPayment": true,
      "name": "<string>",
      "freeUnits": 123,
      "creditsPerUnit": 123,
      "billingModel": "<string>",
      "billingCycle": "<string>"
    }
  ],
  "balance": {
    "creditBalance": 123,
    "creditsPerUnit": 123,
    "currency": "<string>",
    "remainingUnits": 123
  },
  "product": {
    "reference": "<string>",
    "name": "<string>"
  },
  "confirmationUrl": "<string>"
}

Body

application/json
customerRef
string
required
Minimum string length: 1
productRef
string
required
Minimum string length: 1
planRef
string
meterName
string
usageType
string

Response

Limit check result

withinLimits
boolean
required

Whether the customer is within their usage limits

Example:

true

remaining
number
required

Remaining usage units before hitting the limit

Example:

997

checkoutSessionId
string

Checkout session ID if payment is required

Example:

"e3f1c2d4b6a89f001122334455667788"

checkoutUrl
string

Checkout URL if payment is required

Example:

"https://solvapay.com/customer/checkout?id=e3f1c2d4b6a89f001122334455667788"

meterName
string

The meter name to use when tracking usage events

Example:

"requests"

creditBalance
number

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

creditsPerUnit
number

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

currency
string

ISO 4217 currency code for credit fields

activationRequired
boolean

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

plans
object[]

Active plans on the product available for activation or checkout

balance
object

Prepaid usage balance context when the default plan is usage-based

product
object

Product the limit check applies to

confirmationUrl
string

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