Skip to content
ApiqDevelopers
API v1.64.0Open console
API referenceidentity

Get activation limits

GET/v1/activation/limits
Accepts X-Api-Key · oauthClientCredentials · bearer

The capped tier's daily limit — cap, spent today and when it resets

The tenant's LIVE tier and its daily spend cap, which applies to the orders of a LIVE_CAPPED tenant that is not a sandbox twin, on any rung: dailyCap (INR when the activation country is IN, else USD),…Show moreThe tenant's LIVE tier and its daily spend cap, which applies to the orders of a LIVE_CAPPED tenant that is not a sandbox twin, on any rung: dailyCap (INR when the activation country is IN, else USD), usedToday (the tenant's non-cancelled orders since 00:00 UTC, converted to the cap currency at each order's FX snapshot) and resetAt (the next 00:00 UTC). An order that would take usedToday past dailyCap is refused 403 PERMISSION_DENIED details.reason TIER_CAP_REACHED (POST /v1/orders). A tenant whose tier carries no daily cap (TRIAL, LIVE_STANDARD, LIVE_ENTERPRISE) is 409 CONFLICT details.reason TENANT_NOT_CAPPED. tier is x-extensible-enum. Needs tenant:read, as GET /v1/activation; a human session or an API key.

Request body

This operation takes no request body.

Responses

  • 200The tier and its daily limitTierLimits
  • 401
    UNAUTHENTICATED — missing or expired token.Show moreUNAUTHENTICATED — missing or expired token. Declared on every operation because `security` is declared globally at the document root: every route is authenticated, so every route can answer 401.
    ApiErrorResponse
  • 403ApiErrorResponse
  • 405
    VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge).Show moreVALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge). Not retryable as sent.
    ApiErrorResponse
  • 409CONFLICT TENANT_NOT_CAPPED — the tenant's tier carries no daily capApiErrorResponse
  • 414
    VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge).Show moreVALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge). Not retryable as sent: send long input in the body of a POST.
    ApiErrorResponse
  • 500INTERNAL — a bug, and traceId is the support handle.ApiErrorResponse
  • 501Not retryable; the nine-step rail of GET /v1/activation is unchanged.ApiErrorResponse

Errors you should handle

Branch on code and honour retryable — never on the HTTP status alone.

401UNAUTHENTICATED
The bearer token is expired. Re-authenticate and retry.
not retryable
403PERMISSION_DENIED
Reading wallets needs the finance:read permission.
not retryable
405VALIDATION
This method is not served.
not retryable
409CONFLICT
This tenant's tier has no daily limit.
not retryable
414VALIDATION
The request URI is longer than 8 KiB.
not retryable
500INTERNAL
An unexpected error occurred. Quote the traceId to support.
retryable
501NOT_IMPLEMENTED
The capped activation flow is not available on this deployment.
not retryable