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

# Get the phone number allowance

> Returns how many numbers the organization gets for free, how many it holds, what a paid number costs a month, and whether a purchase would be admitted right now.



## OpenAPI

````yaml /api-reference/openapi.documented.json get /v1/phone-number/allowance
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Agent
  - name: Agent Endpoint
  - name: Phone Number
  - name: Call
  - name: Chat
  - name: Metric
  - name: Metric Policy
  - name: Metric Collection Job
  - name: Customer Flow
  - name: Customer Flow Edge Case
  - name: Simulation
  - name: Simulation Persona
  - name: Simulation Environment
  - name: Simulation Scenario
  - name: Simulation Run Plan
  - name: Simulation Template
  - name: Simulation Run Plan Job
  - name: Simulation Job
  - name: HTTP Request Definition
  - name: Webhook
  - name: Issue
  - name: Autoimprove
  - name: Agent Config
  - name: Knowledge Base
  - name: Config
  - name: Organization Project
  - name: Organization Project Member
  - name: Organization Project API Key
  - name: Organization Config
  - name: CLI Auth
  - name: Me
  - name: Project
  - name: Usage
  - name: Analytics
  - name: Dashboard
  - name: Benchmark
  - name: Health
  - name: Prospect Simulation
paths:
  /v1/phone-number/allowance:
    get:
      tags:
        - Phone Number
      summary: Get the phone number allowance
      description: >-
        Returns how many numbers the organization gets for free, how many it
        holds, what a paid number costs a month, and whether a purchase would be
        admitted right now.
      operationId: getV1Phone-numberAllowance
      responses:
        '200':
          description: The phone number allowance
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PhoneNumberAllowanceResponse'
                required:
                  - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Roark from '@roarkanalytics/sdk';

            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });

            const response = await client.phoneNumber.getAllowance();

            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            response = client.phone_number.get_allowance()
            print(response.data)
components:
  schemas:
    PhoneNumberAllowanceResponse:
      type: object
      properties:
        plan:
          type: string
          enum:
            - PAYG
            - TEAM
            - ENTERPRISE
          description: The billing plan the allowance comes from
        freeLimit:
          type: integer
          description: Numbers included at no charge
        used:
          type: integer
          description: Numbers the organization holds right now
        paidCount:
          type: integer
          description: How many of those sit outside the free allowance
        monthlyRentMicros:
          type: integer
          description: What one paid number costs a month, in micro-dollars
        nextIsFree:
          type: boolean
          description: Whether the next number would be free
        canPurchase:
          type: boolean
          description: Whether a purchase would be admitted right now
        blockedReason:
          type:
            - string
            - 'null'
          enum:
            - PAYMENT_METHOD_REQUIRED
            - INSUFFICIENT_CREDITS
            - SPEND_CAP_REACHED
            - PLAN_LIMIT_REACHED
          description: Why a purchase would be refused; null when canPurchase is true
        isOverridden:
          type: boolean
          description: True when the free allowance comes from a per-organization override
      required:
        - plan
        - freeLimit
        - used
        - paidCount
        - monthlyRentMicros
        - nextIsFree
        - canPurchase
        - blockedReason
        - isOverridden
      description: >-
        How many numbers the organization gets for free and whether it may buy
        the next one
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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