---
title: "Check usage limits for a customer and product"
method: POST
path: "/v1/sdk/limits"
tags: ["Limits"]
---

# Check usage limits for a customer and product

`POST /v1/sdk/limits`

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.

## Request body

- CheckLimitRequest
  - `customerRef` string, required
  - `includeCheckoutSession` boolean
  - `meterName` string
  - `productRef` string, required
  - `usageType` string

## Response `200`

Limit check result

- LimitResponse
  - `activationRequired` boolean — True when the customer must activate a priced default plan before usage is allowed
  - `balance` LimitBalanceDto
    - `creditBalance` number, required — Credit balance in credits (100 credits = 1 minor currency unit)
    - `creditsPerUnit` number, required — Credits per usage unit
    - `currency` string, required
    - `remainingUnits` number — Estimated whole units remaining from prepaid credit balance
  - `checkoutSessionId` string — Checkout session ID if payment is required
  - `checkoutUrl` string — Checkout URL if payment is required
  - `confirmationUrl` string — Customer portal confirmation URL when activation is required (fallback when not starting checkout)
  - `creditBalance` number — Credit balance in credits (100 credits = 1 minor currency unit), 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
  - `needsTopUp` boolean — Access is blocked pending an auto-recharge top-up of the prepaid balance — `onExceed: top_up`.
  - `needsUpgrade` boolean — Access is blocked pending a plan switch to the limit's target pricing — `onExceed: auto_upgrade`.
  - `overage` boolean — Access is granted and usage beyond the included cap accrues an overage charge — `onExceed: charge`.
  - `plans` LimitPlanItemDto[] — Active plans on the product available for activation or checkout
    - `billingCycle` string — Derived billing cycle
    - `creditsPerUnit` number — Per-unit charge in minor units (usage-based plans)
    - `currency` string, required
    - `freeUnits` number — Derived included units for the metered allowance
    - `name` string
    - `options` object[] — Composable pricing options for this plan
    - `price` number, required — Headline price in smallest currency unit (e.g. cents)
    - `reference` string, required
    - `requiresPayment` boolean, required
    - `type` string, required — Derived plan type
  - `product` LimitProductBriefDto
    - `name` string
    - `reference` string, required
  - `remaining` number, required — Remaining usage units before hitting the limit. `-1` means unlimited (no finite cap).
  - `throttled` boolean — Access is granted but the caller should degrade/throttle service — the limit was exceeded with `onExceed: throttle`.
  - `upgraded` boolean — The customer was auto-upgraded to the target pricing to restore access — `onExceed: auto_upgrade` succeeded.
  - `withinLimits` boolean, required — Whether the customer is within their usage limits

## Other responses

- `400` — Missing customerRef or productRef
- `404` — Customer or product not found

---

[API](https://skmtc.net/solvapay/apis/solvapay-rest-api.md) · [All operations](https://skmtc.net/solvapay/apis/solvapay-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/solvapay/solvapay-rest-api/revisions/d29ab7373802/schema)