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

Check usage limits for a customer and product

cURL

curl --request POST \
  --url https://api.example.com/v1/sdk/limits \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerRef": "<string>",
  "productRef": "<string>",
  "meterName": "<string>",
  "usageType": "<string>"
}
'

200

{
  "remaining": 997,
  "withinLimits": true,
  "activationRequired": true,
  "balance": {
    "creditBalance": 123,
    "creditsPerUnit": 123,
    "currency": "<string>",
    "remainingUnits": 123
  },
  "checkoutSessionId": "e3f1c2d4b6a89f001122334455667788",
  "checkoutUrl": "https://solvapay.com/customer/checkout?id=e3f1c2d4b6a89f001122334455667788",
  "confirmationUrl": "<string>",
  "creditBalance": 123,
  "creditsPerUnit": 123,
  "currency": "<string>",
  "meterName": "requests",
  "plans": [
    {
      "currency": "<string>",
      "price": 123,
      "reference": "<string>",
      "requiresPayment": true,
      "type": "<string>",
      "billingCycle": "<string>",
      "billingModel": "<string>",
      "creditsPerUnit": 123,
      "freeUnits": 123,
      "name": "<string>"
    }
  ],
  "product": {
    "reference": "<string>",
    "name": "<string>"
  }
}

Body

application/json

customerRef · string · required

Minimum string length: 1

productRef · string · required

Minimum string length: 1

meterName · string

usageType · string

Response

200

application/json

Limit check result

remaining · number · required

Remaining usage units before hitting the limit

Example:

997

withinLimits · boolean · required

Whether the customer is within their usage limits

Example:

true

activationRequired · boolean

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

balance · object

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

Show child attributes

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"

confirmationUrl · string

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

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

meterName · string

The meter name to use when tracking usage events

Example:

"requests"

plans · object[]

Active plans on the product available for activation or checkout

Show child attributes

product · object

Product the limit check applies to

Show child attributes