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

# Get usage

> Returns the current billing-period message usage for the authenticated workspace. Use it to show consumption, remaining allowance, reset timing, and available wallet credits before sending campaigns or high-volume messages.



## OpenAPI

````yaml /openapi.json get /usage
openapi: 3.1.0
info:
  title: Wachat API
  version: v1
  description: >-
    Wachat REST API. Authenticate with a workspace API key: send it as
    `Authorization: Bearer <key>`. Generate keys in the dashboard under
    Developers / API.
servers:
  - url: https://crm.wachat.net/api/v1
security:
  - http: []
tags:
  - name: Message
    description: >-
      Send a single WhatsApp message — text, media (image / video / document /
      audio) or a location pin — to one number, then read its delivery status or
      your message history. A file can be attached directly as a multipart
      `media` field or referenced by a public URL.
  - name: Template
    description: >-
      Create, list and manage your approved WhatsApp templates, and send a
      template to one number with your own header, body variables and button
      values. Use this for utility / marketing sends that need a pre-approved
      template — including one with a PDF / document header (pass the file's
      public URL as the header, e.g. from the Media endpoint).
  - name: Media
    description: >-
      Upload a file once (multipart / form-data, field name `file`, up to 16 MB)
      and get back a hosted public URL you can reuse across sends — for example
      a PDF to use as a document-header on a template, or an image on a message.
  - name: Contact
    description: >-
      Full create / read / update / delete over your contacts and leads,
      including search by number, tags and custom attributes.
  - name: ContactGroup
    description: >-
      Organise contacts into groups: create groups, list them, and add or remove
      members — handy for targeting broadcasts and campaigns.
  - name: Broadcast
    description: >-
      Send the same message to many contacts at once and track each broadcast's
      progress and per-recipient delivery.
  - name: Campaign
    description: >-
      Create, start, pause and monitor drip / marketing campaigns and their
      recipients.
  - name: Scheduled
    description: >-
      Schedule a WhatsApp send for a future time, list upcoming scheduled
      messages, and cancel one before it goes out.
  - name: AutoReply
    description: >-
      Manage keyword auto-replies — the automatic responses that fire when an
      inbound message matches a rule.
  - name: Flow
    description: >-
      Enroll a contact into an automation flow (chatbot) and manage your flows
      through the API.
  - name: Device
    description: >-
      List the WhatsApp numbers / devices connected to your workspace and check
      each one's connection status.
  - name: Webhook
    description: >-
      Register and manage webhook endpoints so Wachat POSTs real-time events
      (message received / sent / delivered / read / failed, plus campaign and
      contact events) to your server. When you set a signing secret each
      delivery carries an HMAC-SHA256 signature header you can verify.
  - name: Deal
    description: >-
      Manage sales-pipeline deals — create, list, update and move deals between
      stages.
  - name: Conversation
    description: >-
      Read your workspace inbox: list chat threads (conversations) and fetch the
      messages inside a thread.
  - name: Account
    description: Read your account details, plan, limits and message-credit usage.
paths:
  /usage:
    get:
      tags:
        - Account
      summary: Get usage
      description: >-
        Returns the current billing-period message usage for the authenticated
        workspace. Use it to show consumption, remaining allowance, reset
        timing, and available wallet credits before sending campaigns or
        high-volume messages.
      operationId: v1.account.usage
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      period:
                        type: object
                        properties:
                          label:
                            type: string
                          resets_on:
                            type: string
                          days_left:
                            type: string
                        required:
                          - label
                          - resets_on
                          - days_left
                      plan:
                        type: object
                        description: >-
                          Plan VALIDITY (subscription expiry) — distinct from
                          the monthly

                          message cycle above; a year out for yearly plans. null
                          = no expiry.
                        properties:
                          name:
                            anyOf:
                              - type: string
                              - type: string
                                enum:
                                  - Free
                          valid_until:
                            type:
                              - string
                              - 'null'
                          valid_until_days:
                            type:
                              - integer
                              - 'null'
                        required:
                          - name
                          - valid_until
                          - valid_until_days
                      messages:
                        type: object
                        properties:
                          used:
                            type: integer
                          limit:
                            type:
                              - integer
                              - 'null'
                          unlimited:
                            type: boolean
                          remaining:
                            type:
                              - object
                              - 'null'
                          percent:
                            anyOf:
                              - type: 'null'
                              - type: object
                              - type: integer
                                enum:
                                  - 0
                        required:
                          - used
                          - limit
                          - unlimited
                          - remaining
                          - percent
                      credits:
                        type: integer
                      meters:
                        type: string
                    required:
                      - period
                      - plan
                      - messages
                      - credits
                      - meters
                  meta:
                    type: string
                required:
                  - data
                  - meta
        '404':
          description: Request failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        const: not_found
                      message:
                        type: string
                        const: Workspace not found.
                      details:
                        type: string
                    required:
                      - code
                      - message
                      - details
                required:
                  - error
components:
  securitySchemes:
    http:
      type: http
      scheme: bearer

````