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

# Get usage summary

> Get usage summary for a billing period



## OpenAPI

````yaml /partner-openapi.json get /partner/usage/summary
openapi: 3.1.0
info:
  title: Contro Partner API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://contro.me/terms
  description: >-
    The Contro Partner API enables Card-as-a-Service (CaaS) partners to
    programmatically issue cards, manage cardholders, and monitor transactions.


    ## Authentication


    All requests require your partner API key in the `x-contro-api-key` header:


    ```

    x-contro-api-key: sk_live_...

    ```


    Use `sk_test_*` keys for sandbox and `sk_live_*` keys for production.


    ## Rate Limits


    The API allows 1,000 requests per minute per API key. When exceeded,
    responses return HTTP 429 with a `Retry-After` header.


    ## Pagination


    List endpoints use page-based pagination:


    ```json

    {
      "data": [...],
      "page": 1,
      "limit": 20,
      "total": 137
    }

    ```


    Pass `?page=2&limit=20` to paginate. `limit` accepts 1–100 (default 20);
    `page` defaults to 1.


    ## Errors


    All errors return:


    ```json

    {
      "success": false,
      "error": "Human-readable message"
    }

    ```
servers:
  - url: https://api.contro.me/v1
    description: Production server for live traffic
  - url: https://stg-api.contro.dev/v1
    description: Sandbox environment for testing
security:
  - apiKey: []
paths:
  /partner/usage/summary:
    get:
      tags:
        - Partner - Usage
      summary: Get usage summary
      description: Get usage summary for a billing period
      operationId: getUsageSummary
      parameters:
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}$
            description: Billing period (YYYY-MM), defaults to current month
            example: 2026-03
          required: false
          description: Billing period (YYYY-MM), defaults to current month
          name: period
          in: query
      responses:
        '200':
          description: Usage summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  period:
                    type: string
                    description: Billing period in YYYY-MM format
                    example: 2026-03
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          description: >-
                            Usage type. One of: card_issuance,
                            transaction_processing, kyc_verification
                          example: card_issuance
                        total:
                          type: number
                          description: Total cost for this type in USD
                          example: 150
                        count:
                          type: number
                          description: Number of operations in this period
                          example: 30
                      required:
                        - type
                        - total
                        - count
                required:
                  - period
                  - items
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '429':
          description: Rate Limited
        '500':
          description: Internal Server Error
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-contro-api-key
      description: Partner API key (sk_live_* for production, sk_test_* for sandbox)

````