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

# Get the sending limits of a line

> Returns the five sending counters of a line with their limits, the reply-lane budget and the time each full counter frees room.

* **Credential:** an API key of the owner of the line. See [Reading the limits and the queue](/guides/sending-limits#reading-the-limits-and-the-queue).
* **Line-scoped keys:** a [line-scoped key](/authentication#line-scoped-keys) gets `403 forbidden` unless the line is in its list, even when the line does not exist.
* **Events:** none.
* **Rolling windows:** every counter counts over a rolling window and none resets at midnight. See [The five limits](/guides/sending-limits#the-five-limits).
* **`*_frees_at`:** the time at which a counter drops back under its limit. `null` when the counter is under its limit, when the limit is 0, or when the time could not be computed: read `null` as "no known wait".
* **Limits in force:** the limits returned are the ones in force on the line. To change them, see [Configuration](/guides/managing-lines#configuration).

## Errors

| Status | `error.code` | When |
| - | - | - |
| 403 | `forbidden` | The request uses a line-scoped key, and the line is not in its list. |
| 404 | `not_found` | No line has this id, or the line is not yours. |

The errors that every operation shares are in [Errors](/errors-and-rate-limits#errors).


## OpenAPI

````yaml GET /v1/lines/{id}/quota
openapi: 3.0.0
info:
  title: iSnap API
  version: 2.45.0
  description: >-
    The iSnap API sends and receives iMessage, RCS and SMS on real phone lines,
    manages those lines, and reports events through webhooks. Every message is
    sent to a real recipient, with an `isnap_live_` key and with an
    `isnap_test_` key alike. Retry a `429` after `Retry-After` seconds. Retry a
    `500` or a `503` up to 2 times, with exponential backoff. Do not retry any
    other `4xx`: fix the request. Retry a write only on an operation that honors
    `Idempotency-Key`, with the key of the first attempt. Responses carry
    personal data: handles, names and message text.
servers:
  - url: https://api.isnap.ai
security:
  - bearerAuth: []
paths:
  /v1/lines/{id}/quota:
    get:
      summary: Get the sending limits of a line
      description: >-
        Returns the five sending limits of a line you own with their counters,
        the reply-lane allowance, the time at which each full counter drops back
        under its limit, and a flag per counter that is `true` from 80% of its
        limit. Accepts an API key. Every counter covers a rolling window: the
        last 60 seconds, the last 60 minutes or the last 24 hours. No counter
        resets at midnight. A held message counts when it is released, not when
        it is accepted.
      parameters:
        - schema:
            type: string
            pattern: ^line_[0-9A-Za-z]{25}$
            description: 'Id of a line: `line_` followed by 25 letters or digits.'
          required: true
          description: 'Id of a line: `line_` followed by 25 letters or digits.'
          name: id
          in: path
      responses:
        '200':
          description: The sending limits of the line and their counters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaEnvelope'
        '400':
          description: >-
            Invalid request. `error.code` is `validation_failed` when a
            parameter, a header or the body does not match its schema:
            `error.issues` then lists each problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No valid credential. `error.code` is `unauthorized`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: >-
            Refused. `forbidden`: the key is line-scoped and this line is
            outside its list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: 'Not found. `not_found`: the line does not exist, or it is not yours.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: >-
            Too many requests. `error.code` is `rate_limit_exceeded` when more
            than 100 requests came from the same network address in 60 seconds,
            whatever their API key or account: wait `error.retry_after` seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '500':
          description: >-
            Unexpected failure. `error.code` is `internal_error`. An operation
            that takes a JSON body also returns it when the body, sent as
            `application/json`, is not valid JSON. Quote `trace_id` when you
            report it to iSnap.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - bearerAuth: []
components:
  schemas:
    QuotaEnvelope:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
          description: Always `true` on a success response.
        data:
          $ref: '#/components/schemas/QuotaSnapshot'
        trace_id:
          type: string
          description: >-
            Trace id of the request that produced this response: 32 lowercase
            hexadecimal characters. Quote it when you report a problem to iSnap.
        request_id:
          type: string
          description: >-
            Id of the request that produced this response: `req_` followed by 25
            letters or digits.
      required:
        - success
        - data
        - trace_id
        - request_id
    ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
          description: Always `false` on an error response.
        data:
          nullable: true
          description: Always `null` on an error response.
        error:
          type: object
          properties:
            status:
              type: integer
              description: The HTTP status of the response.
            code:
              type: string
              description: >-
                Stable machine-readable code that names the refusal. Branch on
                this value.
            message:
              type: string
              description: >-
                Text for a person. It can change between versions: do not branch
                on it.
            retry_after:
              type: integer
              nullable: true
              description: >-
                Seconds to wait before the next attempt. Set on the `429`
                responses that know a delay, where the `Retry-After` header
                carries the same value. When it is above 60 seconds, do not wait
                in a request: schedule the call, or report the time. `null` on
                every other error.
            retry_at:
              type: string
              nullable: true
              description: >-
                ISO 8601 timestamp at which the refusal ends. Set only on `429
                rebind_cap_reached`. `null` on every other error.
            issues:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  path:
                    type: array
                    items:
                      anyOf:
                        - type: string
                        - type: number
                    description: >-
                      Where the problem is: the field names and array indexes
                      that lead to it.
                  message:
                    type: string
                    description: Text for a person.
                  code:
                    type: string
                    description: >-
                      Kind of problem. On `validation_failed`, for example
                      `invalid_type`, `invalid_value`, `invalid_format`,
                      `invalid_union`, `invalid_key`, `invalid_element`,
                      `too_small`, `too_big`, `not_multiple_of`,
                      `unrecognized_keys` or `custom`. The list is open: read
                      `path` and `message`.
                  min:
                    type: integer
                    description: >-
                      Smallest accepted value. Present only on
                      `limit_out_of_bounds`, `mac_quantity_not_a_pack`,
                      `byop_reduction_strands_mac_sessions` and
                      `byop_reduction_strands_byod_lines`.
                  max:
                    type: integer
                    description: >-
                      Largest accepted value. Present only on
                      `limit_out_of_bounds` and
                      `mac_sessions_exceed_byop_lines`, and on the `too_big`
                      issue of an `Idempotency-Key` header longer than 255
                      characters.
                required:
                  - path
                  - message
                  - code
              description: >-
                Problems found in the request, one entry each. Set on most `400
                validation_failed` responses and on the refusals that name a
                field: a refused `handle` of `POST /v1/lookup` has `issues:
                null`. `null` on every other error.
          required:
            - status
            - code
            - message
            - retry_after
            - retry_at
            - issues
          description: >-
            What went wrong. The six fields are always present; `retry_after`,
            `retry_at` and `issues` are `null` when they do not apply.
        trace_id:
          type: string
          description: >-
            Trace id of the request that produced this response: 32 lowercase
            hexadecimal characters. Quote it when you report a problem to iSnap.
        request_id:
          type: string
          description: >-
            Id of the request that produced this response: `req_` followed by 25
            letters or digits.
      required:
        - success
        - data
        - error
        - trace_id
        - request_id
      description: The body of an error response.
    QuotaSnapshot:
      type: object
      properties:
        line_id:
          type: string
          pattern: ^line_[0-9A-Za-z]{25}$
          description: 'Id of a line: `line_` followed by 25 letters or digits.'
        daily_new_contacts_used:
          type: integer
          minimum: 0
          description: Distinct new contacts the line messaged in the last 24 hours.
        daily_new_contact_limit:
          type: integer
          minimum: 0
          description: >-
            Sending limit: distinct new contacts the line can message per
            rolling 24 hours. A new contact is a recipient who has not messaged
            the line in the last 30 days, the default window.
        daily_known_contacts_used:
          type: integer
          minimum: 0
          description: Distinct known contacts the line messaged in the last 24 hours.
        daily_known_contact_limit:
          type: integer
          minimum: 0
          description: >-
            Sending limit: distinct known contacts the line can message per
            rolling 24 hours. A known contact is a recipient who messaged the
            line in the last 30 days, the default window.
        daily_messages_used:
          type: integer
          minimum: 0
          description: Messages the line sent in the last 24 hours.
        daily_total_message_limit:
          type: integer
          minimum: 0
          description: 'Sending limit: messages per rolling 24 hours.'
        hourly_messages_used:
          type: integer
          minimum: 0
          description: Messages the line sent in the last 60 minutes.
        hourly_message_limit:
          type: integer
          minimum: 0
          description: 'Sending limit: messages per rolling 60 minutes.'
        minute_messages_used:
          type: integer
          minimum: 0
          description: Messages the line sent in the last 60 seconds.
        minute_message_limit:
          type: integer
          minimum: 0
          description: 'Sending limit: messages per rolling 60 seconds.'
        daily_replies_used:
          type: integer
          minimum: 0
          description: >-
            Replies that used the reply lane to pass a sending limit in the last
            24 hours.
        daily_reply_limit:
          type: integer
          minimum: 0
          description: >-
            Reply-lane allowance: the number of replies per rolling 24 hours
            that can pass a sending limit through the reply lane.
        minute_frees_at:
          type: string
          nullable: true
          description: >-
            Timestamp at which `minute_messages_used` drops back under its limit
            (ISO 8601, UTC). `null` when the counter is under its limit, when
            the limit is 0, or when the time is not known: read `null` as no
            known wait.
        hourly_frees_at:
          type: string
          nullable: true
          description: >-
            Timestamp at which `hourly_messages_used` drops back under its limit
            (ISO 8601, UTC). `null` when the counter is under its limit, when
            the limit is 0, or when the time is not known: read `null` as no
            known wait.
        daily_total_frees_at:
          type: string
          nullable: true
          description: >-
            Timestamp at which `daily_messages_used` drops back under its limit
            (ISO 8601, UTC). `null` when the counter is under its limit, when
            the limit is 0, or when the time is not known: read `null` as no
            known wait.
        daily_new_frees_at:
          type: string
          nullable: true
          description: >-
            Timestamp at which `daily_new_contacts_used` drops back under its
            limit (ISO 8601, UTC). `null` when the counter is under its limit,
            when the limit is 0, or when the time is not known: read `null` as
            no known wait.
        daily_known_frees_at:
          type: string
          nullable: true
          description: >-
            Timestamp at which `daily_known_contacts_used` drops back under its
            limit (ISO 8601, UTC). `null` when the counter is under its limit,
            when the limit is 0, or when the time is not known: read `null` as
            no known wait.
        daily_reply_frees_at:
          type: string
          nullable: true
          description: >-
            Timestamp at which `daily_replies_used` drops back under its limit
            (ISO 8601, UTC). `null` when the counter is under its limit, when
            the limit is 0, or when the time is not known: read `null` as no
            known wait.
        buckets_warning:
          $ref: '#/components/schemas/BucketsWarning'
      required:
        - line_id
        - daily_new_contacts_used
        - daily_new_contact_limit
        - daily_known_contacts_used
        - daily_known_contact_limit
        - daily_messages_used
        - daily_total_message_limit
        - hourly_messages_used
        - hourly_message_limit
        - minute_messages_used
        - minute_message_limit
        - daily_replies_used
        - daily_reply_limit
        - minute_frees_at
        - hourly_frees_at
        - daily_total_frees_at
        - daily_new_frees_at
        - daily_known_frees_at
        - daily_reply_frees_at
        - buckets_warning
      description: >-
        The sending limits of a line with their counters. Every counter covers a
        rolling window.
    BucketsWarning:
      type: object
      properties:
        new_contacts_at_80_percent:
          type: boolean
          description: >-
            `true` when `daily_new_contacts_used` is at 80% of
            `daily_new_contact_limit` or more.
        known_contacts_at_80_percent:
          type: boolean
          description: >-
            `true` when `daily_known_contacts_used` is at 80% of
            `daily_known_contact_limit` or more.
        messages_at_80_percent:
          type: boolean
          description: >-
            `true` when `daily_messages_used` is at 80% of
            `daily_total_message_limit` or more.
        hourly_at_80_percent:
          type: boolean
          description: >-
            `true` when `hourly_messages_used` is at 80% of
            `hourly_message_limit` or more.
        minute_at_80_percent:
          type: boolean
          description: >-
            `true` when `minute_messages_used` is at 80% of
            `minute_message_limit` or more.
      required:
        - new_contacts_at_80_percent
        - known_contacts_at_80_percent
        - messages_at_80_percent
        - hourly_at_80_percent
        - minute_at_80_percent
      description: >-
        One flag per sending limit: `true` from 80% of the limit. A flag is
        `false` when its limit is 0.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key created in the iSnap dashboard, or a trial key, sent as
        `Authorization: Bearer <key>`. An API key starts with `isnap_live_` or
        `isnap_test_`; both act on the same account, lines and billing. A trial
        key acts on its trial only.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.