Telnyx Bundles API
The Bundles API from Telnyx — 2 operation(s) for bundles.
The Bundles API from Telnyx — 2 operation(s) for bundles.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/telnyx:telnyx-bundles-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Telnyx Bundles API
version: 2.0.0
contact:
email: support@telnyx.com
x-endpoint-cost: light
x-refined-note:
- x-latency-category differs across the merged source definitions and was not carried
description: 'Operations tagged Bundles across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Bundles
paths:
/bundle_pricing/billing_bundles:
get:
tags:
- Bundles
summary: Retrieve Bundles
description: Returns a paginated list of the billing bundles available to your account, with support for filtering.
operationId: GetUserBillingBundles
parameters:
- $ref: '#/components/parameters/bundle-pricing_FilterConsolidated'
- $ref: '#/components/parameters/bundle-pricing_PageConsolidated'
- $ref: '#/components/parameters/AuthorizationBearer'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBillingBundlesResponse'
'400':
$ref: '#/components/responses/bundle-pricing_BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
default:
$ref: '#/components/responses/bundle-pricing_GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/bundle_pricing/billing_bundles/{bundle_id}:
get:
tags:
- Bundles
summary: Get Bundle By Id
description: Returns the details of a single billing bundle by its ID, so you can inspect its contents before purchasing a user bundle.
operationId: GetBillingBundleById
parameters:
- $ref: '#/components/parameters/BundleId'
- $ref: '#/components/parameters/AuthorizationBearer'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BillingBundleResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/bundle-pricing_NotFoundErrorResponse'
default:
$ref: '#/components/responses/bundle-pricing_GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
responses:
bundle-pricing_BadRequestErrorResponse:
description: Invalid request parameters
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
title:
type: string
detail:
type: string
example:
errors:
- code: '10015'
title: Bad Request
detail: The request failed because it was not well-formed.
bundle-pricing_NotFoundErrorResponse:
description: Resource not found
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
title:
type: string
detail:
type: string
example:
errors:
- code: '10005'
title: Resource not found
detail: The requested resource or URL could not be found.
UnauthorizedErrorResponse:
description: Authentication required or invalid credentials
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
title:
type: string
detail:
type: string
example:
errors:
- code: '10009'
title: Authentication failed
detail: The required authentication headers were either invalid or not included in the request.
bundle-pricing_GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
title:
type: string
detail:
type: string
example:
errors:
- code: '10007'
title: Unexpected error
detail: An unexpected error occured.
bundle-pricing_BadRequestErrorResponse_2:
content:
application/json:
schema:
properties:
errors:
items:
properties:
code:
type: string
detail:
type: string
title:
type: string
type: object
type: array
type: object
description: Invalid request parameters
bundle-pricing_NotFoundErrorResponse_2:
content:
application/json:
schema:
properties:
errors:
items:
properties:
code:
type: string
detail:
type: string
title:
type: string
type: object
type: array
type: object
description: Resource not found
UnauthorizedErrorResponse_2:
content:
application/json:
schema:
properties:
errors:
items:
properties:
code:
type: string
detail:
type: string
title:
type: string
type: object
type: array
type: object
description: Authentication required or invalid credentials
bundle-pricing_GenericErrorResponse_2:
content:
application/json:
schema:
properties:
errors:
items:
properties:
code:
type: string
detail:
type: string
title:
type: string
type: object
type: array
type: object
description: Unexpected error
schemas:
BillingBundleSchema:
title: BillingBundleSchema
required:
- id
- name
- cost_code
- active
- is_public
- created_at
- bundle_limits
type: object
properties:
id:
title: Id
type: string
format: uuid
example: 7ecd040e-6bac-4139-9160-3c0427d98fea
description: Bundle's ID, this is used to identify the bundle in the API.
name:
title: Name
type: string
example: Australia Basic
description: Bundle's name, this is used to identify the bundle in the UI.
slug:
title: Slug
type: string
example: basic-au-e4f8
description: Slugified version of the bundle's name.
cost_code:
title: Cost Code
type: string
example: BUNDLE-PRICING-BASIC-MRC
description: Bundle's cost code, this is used to identify the bundle in the billing system.
active:
title: Active
type: boolean
description: If that bundle is active or not.
is_public:
title: Is Public
type: boolean
description: Available to all customers or only to specific customers.
created_at:
title: Created At
type: string
format: date
description: Date the bundle was created.
bundle_limits:
title: Bundle Limits
type: array
items:
$ref: '#/components/schemas/BundleLimitSchema'
BillingBundleSummary:
title: BillingBundleSummary
required:
- id
- name
- cost_code
- is_public
- created_at
type: object
properties:
id:
title: Id
type: string
format: uuid
example: 7ecd040e-6bac-4139-9160-3c0427d98fea
description: Bundle's ID, this is used to identify the bundle in the API.
name:
title: Name
type: string
example: Australia Basic
description: Bundle's name, this is used to identify the bundle in the UI.
slug:
title: Slug
type: string
example: basic-au-e4f8
description: Slugified version of the bundle's name.
cost_code:
title: Cost Code
type: string
example: BUNDLE-PRICING-BASIC-MRC
description: Bundle's cost code, this is used to identify the bundle in the billing system.
is_public:
title: Is Public
type: boolean
description: Available to all customers or only to specific customers.
created_at:
title: Created At
type: string
format: date
description: Date the bundle was created.
mrc_price:
title: Mrc Price
type: number
format: float
example: 2
description: Monthly recurring charge price.
currency:
title: Currency
type: string
example: USD
description: Bundle's currency code.
specs:
title: Specs
type: array
items:
type: string
example:
- 1 AU Number
- Emergency Calling
- All inbound and outbound calling billed pay-as-you-go
PaginatedBillingBundlesResponse:
title: PaginatedBillingBundlesResponse
required:
- meta
- data
type: object
properties:
meta:
$ref: '#/components/schemas/PaginationResponse'
data:
title: Data
type: array
items:
$ref: '#/components/schemas/BillingBundleSummary'
PaginationResponse:
title: PaginationResponse
required:
- total_results
- total_pages
- page_number
- page_size
type: object
properties:
total_results:
title: Total Results
type: integer
example: 55
description: Total number of results returned.
total_pages:
title: Total Pages
type: integer
example: 3
description: Total number of pages from the results.
page_number:
title: Page Number
type: integer
example: 2
description: The current page number.
page_size:
title: Page Size
type: integer
example: 25
description: The number of results per page.
BillingBundleResponse:
title: BillingBundleResponse
required:
- data
type: object
properties:
data:
$ref: '#/components/schemas/BillingBundleSchema'
BundleLimitDirection:
title: BundleLimitDirection
enum:
- inbound
- outbound
type: string
description: An enumeration.
BundleLimitSchema:
title: BundleLimitSchema
required:
- id
- service
- metric
- created_at
- updated_at
type: object
properties:
id:
title: Id
type: string
format: uuid
example: e6a32ea9-953b-4622-bbba-9f7bcf7e6717
service:
title: Service
type: string
example: E911
metric:
title: Metric
type: string
example: number
limit:
title: Limit
type: integer
example: 1
rate:
title: Rate
type: string
example: '5'
country_iso:
title: Country Iso
type: string
example: AU
country_code:
title: Country Code
type: integer
example: 61
country:
title: Country
type: string
description: Use country_iso instead
deprecated: true
direction:
$ref: '#/components/schemas/BundleLimitDirection'
types:
title: Types
type: array
items:
type: string
example: local
created_at:
title: Created At
type: string
format: date
updated_at:
title: Updated At
type: string
format: date
billing_service:
title: Billing Service
type: string
example: emergency
parameters:
BundleId:
required: true
schema:
title: Bundle Id
type: string
format: uuid
example: 8661948c-a386-4385-837f-af00f40f111a
description: Billing bundle's ID, this is used to identify the billing bundle in the API.
name: bundle_id
in: path
description: Unique identifier of the bundle.
AuthorizationBearer:
name: authorization_bearer
in: header
schema:
type: string
description: Authenticates the request with your Telnyx API V2 KEY
description: 'Format: Bearer <TOKEN>'
bundle-pricing_FilterConsolidated:
name: filter
in: query
style: deepObject
explode: true
description: 'Consolidated filter parameter (deepObject style). Supports filtering by country_iso and resource. Examples: filter[country_iso]=US or filter[resource]=+15617819942'
schema:
type: object
properties:
country_iso:
title: Filter[Country Iso]
type: array
items:
type: string
example: US
description: Filter by country code.
resource:
title: Filter[Resource]
type: array
items:
type: string
description: Filter by resource.
example: '+15617819942'
description: Filter by resource.
bundle-pricing_PageConsolidated:
name: page
in: query
style: deepObject
explode: true
description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]'
schema:
type: object
properties:
size:
type: integer
minimum: 1
maximum: 250
default: 20
description: The size of the page.
number:
type: integer
minimum: 1
default: 1
description: The page number to load.
BundleId_2:
in: path
name: bundle_id
required: true
schema:
description: Billing bundle's ID, this is used to identify the billing bundle in the API.
example: 8661948c-a386-4385-837f-af00f40f111a
format: uuid
title: Bundle Id
type: string
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: API key
description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
Payment:
type: apiKey
in: header
name: Authorization
description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
agent-memory_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
bearerAuth:
type: http
scheme: bearer
branded-calling_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
collections_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
number-reputation_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
oauthClientAuth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
authorizationCode:
authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
tokenUrl: https://api.telnyx.com/v2/oauth/token
refreshUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
description: OAuth 2.0 authentication for Telnyx API and MCP integrations
outbound-voice-profiles_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
pronunciation-dicts_bearerAuth:
type: http
scheme: bearer
description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
rcs-registration_bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
stored-payment-transactions_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
transcriptions-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
web-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
pay-connectors_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key, not the processor bearer token.
telnyxApiKey:
type: http
scheme: bearer
description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
categories:
- communication
- developer-tools
docs:
apiReference: https://developers.telnyx.com
homepage: https://telnyx.com
llms: https://telnyx.com/llms.txt