> ## 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.

# 查询指定期数的订阅使用量

> 商家查询指定期数的订阅使用量

商家查询指定期数的订阅使用量


## OpenAPI

````yaml openapi/v1-zh.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: 折扣
    description: 折扣
  - name: 发票
    description: 发票
  - name: 退款
    description: 退款
  - name: 商品管理
    description: 商品管理
  - name: 订阅
    description: 订阅
  - name: 商品定价
    description: 商品定价方案
  - name: 交易单
    description: 交易单
  - name: 支付流水
    description: 支付流水
  - name: 结账会话
    description: 结账会话
  - name: 顾客
    description: 顾客
  - name: 顾客门户
    description: 顾客门户
  - name: Webhook
    description: Webhook
  - name: 争议
    description: 争议订单
paths:
  /api/v1/subscription/{subscription_id}/usage:
    get:
      tags:
        - 订阅
      summary: 查询指定期数的订阅使用量
      description: 商家查询指定期数的订阅使用量
      operationId: v1-subscription-get-subscription-usage
      parameters:
        - name: subscription_id
          in: path
          description: 订阅 ID
          required: true
          schema:
            type: string
        - name: merchant_id
          in: query
          description: 商户唯一标识
          schema:
            type: string
        - name: cycle_index
          in: query
          description: 订阅周期, 不传默认查询最新周期
          schema:
            type: integer
            format: int32
        - $ref: '#/components/parameters/HeaderRequestID'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionUsageResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
              example:
                code: system_error
                message: Internal server error.
components:
  parameters:
    HeaderRequestID:
      name: Request-Id
      in: header
      description: 请求的唯一标识符
      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: 获取订阅使用量响应
    BaseResponse:
      type: object
      properties:
        code:
          type: string
          description: 错误码
        message:
          type: string
          description: 错误详细信息
    GetSubscriptionUsageResponse_Data:
      type: object
      properties:
        subscription_id:
          type: string
          description: 订阅唯一标识
        total_usage_count:
          type: integer
          description: 总使用量
          format: int32
        billing_usage_count:
          type: integer
          description: 计费使用量 = 总使用量 - 试用期使用量
          format: int32
        trial_usage_count:
          type: integer
          description: 试用期使用量
          format: int32
        usage_unit:
          type: string
          description: 使用量单位
        billing_amount:
          type: string
          description: 计费金额
        currency:
          type: string
          description: 币种
      description: 获取订阅使用量响应
  securitySchemes:
    sec0:
      type: http
      description: 'Bearer API Key 鉴权。格式：Authorization: Bearer {your_api_key}'
      scheme: bearer

````