> ## Documentation Index > Fetch the complete documentation index at: https://docs.shelfforce.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get usage > Returns current credit balance, plan details, and per-endpoint rate-limit allocations. ## OpenAPI ````yaml /openapi.json get /api/v1/usage openapi: 3.1.0 info: title: Shelfforce API version: 1.0.0 description: >- Shelfforce turns shelf photos into structured retail data. Submit images for AI-powered shelf analysis, manage tasks and inventory, and retrieve compliance and share-of-shelf reports. All API requests require a Bearer token (API key with `sf_live_` prefix). Rate limits are enforced per tier using a fixed 60-second window. Idempotency is supported on POST and PATCH via the `Idempotency-Key` header (24h TTL). 1 credit = 1 image analysis. Batch submissions consume 1 credit per image (max batch size depends on plan tier: 20-200). Tag analyses with `externalId` and `metadata` for B2B tracking, and use `callbackUrl` for per-request completion notifications. termsOfService: https://shelfforce.ai/terms contact: name: Shelfforce Support url: https://shelfforce.ai/support email: hey@shelfforce.ai license: name: Proprietary url: https://shelfforce.ai/terms servers: - url: https://shelfforce.ai description: Production security: - bearerAuth: [] tags: - name: Analyses description: Submit images for AI shelf analysis and retrieve results. - name: Products description: Browse products detected across analyses. - name: Places description: Manage store locations tied to your organisation. - name: Tasks description: Create and manage field data-collection tasks. - name: Inventory description: Maintain a master catalogue of expected SKUs. - name: Reports description: 'Aggregated analytics: share of shelf and store performance.' - name: Webhooks description: Register endpoints to receive real-time event notifications. - name: Usage description: Check credit balance, plan details, and rate-limit status. - name: Orders description: Create and manage purchase orders with line items. - name: Accounts description: Manage brand, supplier, distributor, and partner accounts. - name: Alerts description: >- Read and manage system-generated alerts. Alerts are created automatically — no POST endpoint. - name: Members description: >- List, invite, update, and remove organisation members. Admin role required for writes. paths: /api/v1/usage: get: tags: - Usage summary: Get usage description: >- Returns current credit balance, plan details, and per-endpoint rate-limit allocations. operationId: getUsage responses: '200': description: Usage and plan details. headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/Usage' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: headers: X-RateLimit-Limit: description: Maximum number of requests allowed in the current 60-second window. schema: type: integer examples: - 120 X-RateLimit-Remaining: description: Number of requests remaining in the current window. schema: type: integer examples: - 117 X-RateLimit-Reset: description: Unix timestamp (seconds) when the current rate-limit window resets. schema: type: integer examples: - 1740300060 X-Request-Id: description: Unique identifier for this request. Include in support tickets. schema: type: string format: uuid examples: - 550e8400-e29b-41d4-a716-446655440000 schemas: Usage: type: object required: - credits - plan - rateLimits - maxBatchSize properties: maxBatchSize: type: integer description: Maximum number of images per batch request for your plan tier. examples: - 50 credits: type: object required: - remaining - usedThisPeriod - plan - payg properties: remaining: type: integer description: Credits remaining in the current billing period. examples: - 847 usedThisPeriod: type: integer description: Credits consumed in the current billing period. examples: - 153 plan: type: integer description: Total plan credits per billing period. examples: - 1000 payg: type: integer description: Pay-as-you-go credits purchased on top of the plan. examples: - 0 plan: type: object required: - tier - billingInterval - periodEnd properties: tier: type: string description: Plan tier name. examples: - growth billingInterval: type: string enum: - monthly - annual description: Billing cycle. examples: - monthly periodEnd: type: string format: date-time description: End of the current billing period. examples: - '2026-03-23T00:00:00Z' rateLimits: type: object required: - analyses - reads - writes properties: analyses: $ref: '#/components/schemas/RateLimitBucket' reads: $ref: '#/components/schemas/RateLimitBucket' writes: $ref: '#/components/schemas/RateLimitBucket' RateLimitBucket: type: object required: - limit - remaining - resetAt description: Rate-limit status for an endpoint category. properties: limit: type: integer description: Max requests per 60-second window. examples: - 20 remaining: type: integer description: Requests remaining in the current window. examples: - 18 resetAt: type: string format: date-time description: When the current window resets. examples: - '2026-02-23T10:31:00Z' responses: Unauthorized: description: Authentication failed. Provide a valid API key as a Bearer token. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - AUTH_REQUIRED - INVALID_API_KEY examples: - INVALID_API_KEY message: type: string examples: - The provided API key is invalid or has been revoked. RateLimited: description: Too many requests. Wait until the rate-limit window resets. headers: Retry-After: description: Seconds until the rate-limit window resets. schema: type: integer examples: - 12 X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string const: RATE_LIMITED examples: - RATE_LIMITED message: type: string examples: - Rate limit exceeded. Retry after 12 seconds. InternalError: description: An unexpected server error occurred. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string const: INTERNAL_ERROR examples: - INTERNAL_ERROR message: type: string examples: - >- An unexpected error occurred. Please try again or contact support with request ID. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- API key with `sf_live_` prefix. Pass as `Authorization: Bearer sf_live_...` ````