# View usage for all sub-accounts

Retrieves usage data for all sub-accounts under a Partner account, including current and previous period comparisons.

This endpoint is only available to Signable Partners.


Endpoint: GET /usage
Version: 1.0.0
Security: basicAuth

## Query parameters:

  - `offset` (integer)
    The index of the first envelope to retrieve.

  - `limit` (integer)
    The maximum number of envelopes to return. If more than  is requested,  will be returned instead.

## Response 200 fields (application/json):

  - `http` (integer, required)
    HTTP status code of the response.
    Example: 200

  - `offset` (integer, required)
    Number of sub-accounts skipped before the returned result set.

  - `limit` (integer, required)
    Maximum number of sub-accounts returned in the response.
    Example: 10

  - `total_companies` (string, required)
    Total number of sub-accounts available.
    Example: "2"

  - `current_start_date` (string, required)
    Start of the current reporting period.
    Example: "2024-12-01T00:00:00+0000"

  - `current_end_date` (string, required)
    End of the current reporting period.
    Example: "2025-01-01T00:00:00+0000"

  - `previous_start_date` (string, required)
    Start of the previous reporting period.
    Example: "2024-11-01T00:00:00+0000"

  - `previous_end_date` (string, required)
    End of the previous reporting period.
    Example: "2024-12-01T00:00:00+0000"

  - `companies` (array, required)
    List of usage stats per sub-account.

  - `companies.company_id` (string, required)
    Unique identifier of the sub-account.
    Example: "196735"

  - `companies.company_name` (string, required)
    Name of the sub-account.
    Example: "ExampleSubAccount_1"

  - `companies.current_usage` (string, required)
    Number of documents sent in the current reporting period.
    Example: "1"

  - `companies.previous_usage` (string, required)
    Number of documents sent in the previous reporting period.
    Example: "6"

  - `companies.company_created` (string, required)
    Timestamp when the sub-account was created.
    Example: "2024-09-03T09:03:12+0000"