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

# Get Subscription Usage

> Get Subscription Usage



## OpenAPI

````yaml openapi/v1-en.yaml GET /api/v1/subscription/{subscription_id}/usage
openapi: 3.0.3
info:
  title: Subotiz API
  description: Subotiz OpenAPI
  version: 1.0.0
servers:
  - url: https://{api}.subotiz.com
    variables:
      api:
        default: api
security:
  - sec0: []
tags:
  - name: Subscription
    description: Subscription
  - name: Price
    description: Price
  - name: Trade
    description: Trade
  - name: Payment
    description: Payment
  - name: Checkout Session
    description: Checkout Session
  - name: Customer
    description: Customer
  - name: Customer Portal
    description: Customer Portal
paths:
  /api/v1/subscription/{subscription_id}/usage:
    get:
      tags:
        - Subscription
      summary: Get Subscription Usage
      description: Get Subscription Usage
      operationId: v1-subscription-get-subscription-usage
      parameters:
        - name: subscription_id
          in: path
          description: Subscription ID
          required: true
          schema:
            type: string
        - name: merchant_id
          in: query
          description: Merchant unique identifier
          schema:
            type: string
        - name: cycle_index
          in: query
          description: Cycle index, default to the latest cycle
          schema:
            type: integer
            format: int32
        - $ref: '#/components/parameters/HeaderRequestID'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionUsageResponse'
        '422':
          description: merchant_id is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
              example:
                code: InvalidParameter
                message: merchant_id is required.
components:
  parameters:
    HeaderRequestID:
      name: Request-Id
      in: header
      description: The unique identifier of the request
      required: true
      schema:
        type: string
        default: 008e3967-a1b5-48bb-be14-d5bff5092e61
  schemas:
    GetSubscriptionUsageResponse:
      type: object
      properties:
        code:
          type: string
          description: error code
        message:
          type: string
          description: error message
        data:
          $ref: '#/components/schemas/GetSubscriptionUsageResponse_Data'
      description: Get subscription usage response
    BaseResponse:
      type: object
      properties:
        code:
          type: string
          description: error code
        message:
          type: string
          description: error message
    GetSubscriptionUsageResponse_Data:
      type: object
      properties:
        subscription_id:
          type: string
          description: Subscription unique identifier
        total_usage_count:
          type: integer
          description: Total usage count
          format: int32
        billing_usage_count:
          type: integer
          description: Billing usage count
          format: int32
        trial_usage_count:
          type: integer
          description: Trial usage count
          format: int32
        usage_unit:
          type: string
          description: Usage unit
        billing_amount:
          type: string
          description: Billing amount
        currency:
          type: string
          description: Currency
      description: Get subscription usage response
  securitySchemes:
    sec0:
      type: http
      description: >-
        Bearer API Key authentication. Format: Authorization: Bearer
        {your_api_key}
      scheme: bearer

````