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

# Subscription change audit log

> Returns a paginated, filterable log of subscription changes.



## OpenAPI

````yaml /openapi/wsapi-api.yaml get /account/subscriptions/{id}/changes
openapi: 3.0.3
info:
  title: WSAPI - WhatsApp API
  description: >-
    RESTful HTTP API for WhatsApp via whatsmeow. Supports multi-instance
    connections, connections, webhook event delivery, and HMAC-SHA256 signing.
    Includes self-service instance management endpoints served by the API
    Gateway.
  version: 2.0.0
servers:
  - url: https://api.wsapi.chat
    description: WSAPI API
security:
  - ApiKeyAuth: []
tags:
  - name: Account
    description: >-
      Customer account management — instances, subscriptions, and default
      settings (CustomerApiKey auth)
  - name: Session
    description: WhatsApp session management (login, logout, status)
  - name: Messages
    description: Send and manage WhatsApp messages
  - name: Groups
    description: Group management
  - name: Communities
    description: Community management
  - name: Contacts
    description: Contact lookup and management
  - name: Users
    description: Own account management, user lookup, and profile information
  - name: Media
    description: Media download
  - name: Chats
    description: Chat listing, info, settings, and management
  - name: Calls
    description: Call management
  - name: Newsletters
    description: Newsletter/channel management
  - name: Status
    description: Status/stories posting
paths:
  /account/subscriptions/{id}/changes:
    get:
      tags:
        - Account
      summary: Subscription change audit log
      description: Returns a paginated, filterable log of subscription changes.
      operationId: listAccountSubscriptionChanges
      parameters:
        - $ref: '#/components/parameters/SubscriptionId'
        - $ref: '#/components/parameters/PageNumber'
        - $ref: '#/components/parameters/PageSize'
        - name: timestampFrom
          in: query
          schema:
            type: string
            format: date-time
        - name: timestampTo
          in: query
          schema:
            type: string
            format: date-time
        - name: changeType
          in: query
          schema:
            type: string
        - name: instanceId
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Paginated list of changes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedAccountSubscriptionChanges'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - CustomerApiKey: []
components:
  parameters:
    SubscriptionId:
      name: id
      in: path
      required: true
      schema:
        type: string
    PageNumber:
      name: pageNumber
      in: query
      schema:
        type: integer
        default: 1
    PageSize:
      name: pageSize
      in: query
      schema:
        type: integer
        default: 20
  schemas:
    PagedAccountSubscriptionChanges:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AccountSubscriptionChange'
        totalCount:
          type: integer
        pageNumber:
          type: integer
        pageSize:
          type: integer
    AccountSubscriptionChange:
      type: object
      properties:
        id:
          type: string
        timestamp:
          type: string
          format: date-time
        subscriptionId:
          type: string
        changeType:
          type: string
        previousQuantity:
          type: integer
          nullable: true
        newQuantity:
          type: integer
          nullable: true
        instanceId:
          type: string
          nullable: true
        proratedAmount:
          type: number
          format: decimal
          nullable: true
        notes:
          type: string
          nullable: true
    Error:
      type: object
      description: Standard error response returned by all API endpoints
      required:
        - detail
        - status
      properties:
        detail:
          type: string
          description: Human-readable error message
          example: invalid request body
        status:
          type: integer
          description: HTTP status code
          example: 400
  responses:
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 401
            detail: unauthorized
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 404
            detail: not found
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Instance or customer-level API key. Either the instance's own API key or
        the customer's API key is accepted. Must be paired with the
        X-Instance-Id header to identify the target instance.
    CustomerApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Customer API key. Only the customer-level key is accepted for /account/*
        endpoints. No X-Instance-Id header is required.

````