> ## 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. # Buy a phone number > Buys a number from the carrier for this project. Free inside the plan allowance; past it, the first month of rent is charged now and monthly after that. ## OpenAPI ````yaml /api-reference/openapi.documented.json post /v1/phone-number 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: post: tags: - Phone Number summary: Buy a phone number description: >- Buys a number from the carrier for this project. Free inside the plan allowance; past it, the first month of rent is charged now and monthly after that. operationId: postV1Phone-number requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePhoneNumberInput' responses: '201': description: The purchased phone number content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PhoneNumberResponse' required: - data '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Validation error example: type: validation code: invalid_parameter message: The request was invalid param: email description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication error example: type: authentication code: unauthorized message: Authentication required description: Unauthorized '402': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Insufficient credit example: type: payment_required code: insufficient_credits message: >- Not enough credit to start this work. Add credit and try again. description: Payment Required '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 '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Not found error example: type: not_found code: resource_not_found message: The requested resource could not be found description: Not Found '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Conflict error example: type: conflict code: resource_in_use message: The resource is in use and cannot be deleted description: Conflict '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 phoneNumber = await client.phoneNumber.create({ e164: '+14155550123' }); console.log(phoneNumber.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 ) phone_number = client.phone_number.create( e164="+14155550123", ) print(phone_number.data) components: schemas: CreatePhoneNumberInput: type: object properties: e164: type: string pattern: ^\+[1-9]\d{1,14}$ description: The number to buy, in E.164 format, from a search result example: '+14155550123' name: type: string minLength: 1 maxLength: 80 description: A label for the number agentId: type: string format: uuid description: The agent to assign the number to expectFree: type: boolean description: >- Whether you expect this number to be free (from the allowance). The purchase is refused with 409 if that has changed since you checked. expectMonthlyRentMicros: type: integer minimum: 0 description: >- The monthly rent you expect for a paid number, in micros (from the allowance). The purchase is refused with 409 if that has changed since you checked. example: 2000000 required: - e164 description: Input for buying a phone number PhoneNumberResponse: type: object properties: id: type: string format: uuid description: Phone number ID e164: type: string description: The number in E.164 format example: '+14155550123' name: type: - string - 'null' description: Label the project gave the number localityCode: type: - string - 'null' description: >- ISO 3166-2 code of the region the number is from, when the carrier gave one purchasedAt: type: string description: When the number was bought (ISO 8601) rentNextChargeAt: type: string description: When the next month of rent is due (ISO 8601) isFree: type: boolean description: Whether the number sits inside the plan free allowance right now monthlyRentMicros: type: integer description: >- What a month of this number costs in micro-dollars; 0 while it is free agentId: type: - string - 'null' format: uuid description: The agent the number is assigned to, if any required: - id - e164 - name - localityCode - purchasedAt - rentNextChargeAt - isFree - monthlyRentMicros - agentId description: A phone number the project owns 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.