> ## Documentation Index
> Fetch the complete documentation index at: https://billing-docs.platform.ai71services.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Report entitlement usage



## OpenAPI

````yaml specs/billing_api_docs.json post /api/v1/entitlements/report
openapi: 3.0.1
info:
  title: Billing API
  description: Billing service for managing subscriptions, payments, and entitlements
  contact: {}
  version: '1.0'
servers:
  - url: https://dev-billing-api.iqraa.ai/api/v1
security: []
tags:
  - name: Customers
    description: Customers related endpoints
  - name: Subscriptions
    description: Subscription related endpoints
  - name: Plans
    description: Plans related endpoints
  - name: Entitlements
    description: Entitlements related endpoints
  - name: Payments
    description: Payments related endpoints
  - name: Emails
    description: Email related endpoints
paths:
  /api/v1/entitlements/report:
    post:
      tags:
        - Entitlements
      summary: Report entitlement usage
      operationId: EntitlementController_reportUsage
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitlementReportUsageDto'
      responses:
        '201':
          description: Usage reported successfully
        '400':
          description: Bad request - Invalid usage data
        '403':
          description: Forbidden - Not authorized to report entitlement usage
      security:
        - bearer: []
components:
  schemas:
    EntitlementReportUsageDto:
      type: object
      properties:
        subscriptionId:
          type: string
          description: The unique identifier of the subscription
          example: 0c7b0eb6-3411-4dd3-9e24-d2a8edbb504a
        customerSubscribedId:
          type: string
          description: >-
            The unique identifier of the customer who is subscribed (external
            customer id)
          example: '247'
        entitlementCode:
          type: string
          description: The unique identifier of the entitlement
          example: STARTER
        usage:
          type: number
          description: The usage amount to be reported
          example: 100
      required:
        - subscriptionId
        - entitlementCode
        - usage
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: opaque
      type: http

````