Telnyx User Bundles API

openapi: 3.2.0
info:
  title: Telnyx User 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 User 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: User Bundles
paths:
  /bundle_pricing/user_bundles:
    get:
      tags:
      - User Bundles
      summary: Get User Bundles
      operationId: GetUserBundles
      description: Returns a paginated list of the bundles active on your account, with support for filtering.
      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/PaginatedUserBundlesResponse'
        '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/user_bundles/bulk:
    post:
      summary: Create User Bundles
      description: Creates multiple user bundles for the user.
      operationId: CreateUserBundlesBulk
      parameters:
      - $ref: '#/components/parameters/AuthorizationBearer'
      tags:
      - User Bundles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserBundlesBulkRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedUserBundlesResponse'
        '400':
          $ref: '#/components/responses/bundle-pricing_BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/bundle-pricing_NotFoundErrorResponse'
        '422':
          $ref: '#/components/responses/bundle-pricing_UnprocessableEntityErrorResponse'
        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/user_bundles/unused:
    get:
      tags:
      - User Bundles
      summary: Get Unused User Bundles
      description: Returns all user bundles that aren't in use.
      operationId: GetUnusedUserBundles
      parameters:
      - $ref: '#/components/parameters/bundle-pricing_FilterConsolidated'
      - $ref: '#/components/parameters/AuthorizationBearer'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnusedUserBundlesResponse'
        '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/user_bundles/{user_bundle_id}:
    delete:
      tags:
      - User Bundles
      summary: Deactivate User Bundle
      description: Deactivates the specified user bundle on your account and returns the deactivated bundle.
      operationId: DeactivateUserBundle
      parameters:
      - $ref: '#/components/parameters/UserBundleId'
      - $ref: '#/components/parameters/AuthorizationBearer'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBundleCreateResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '404':
          $ref: '#/components/responses/bundle-pricing_NotFoundErrorResponse'
        '422':
          $ref: '#/components/responses/bundle-pricing_UnprocessableEntityErrorResponse'
        default:
          $ref: '#/components/responses/bundle-pricing_GenericErrorResponse'
    get:
      tags:
      - User Bundles
      summary: Get User Bundle by Id
      description: Returns the details of a single user bundle on your account by its ID.
      operationId: GetUserBundleById
      parameters:
      - $ref: '#/components/parameters/UserBundleId'
      - $ref: '#/components/parameters/AuthorizationBearer'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBundleResponse'
        '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
  /bundle_pricing/user_bundles/{user_bundle_id}/resources:
    get:
      tags:
      - User Bundles
      summary: Get User Bundle Resources
      description: Retrieves the resources of a user bundle by its ID.
      operationId: GetUserBundleResources
      parameters:
      - $ref: '#/components/parameters/UserBundleId'
      - $ref: '#/components/parameters/AuthorizationBearer'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBundleResourcesResponse'
        '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:
  schemas:
    UserBundleResponse:
      title: UserBundleResponse
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UserBundle'
    PaginatedUserBundlesResponse:
      title: PaginatedUserBundlesResponse
      required:
      - meta
      - data
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/PaginationResponse'
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/UserBundle'
    UserBundleCreateResponse:
      title: UserBundleCreateResponse
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UserBundle'
    UnusedUserBundlesSchema:
      title: UnusedUserBundlesSchema
      required:
      - billing_bundle
      - user_bundle_ids
      type: object
      properties:
        billing_bundle:
          $ref: '#/components/schemas/BillingBundleSummary'
        user_bundle_ids:
          title: User Bundle Ids
          type: array
          items:
            type: string
            format: uuid
          description: List of user bundle IDs for given bundle.
          example:
          - 1e650b96-4c6a-4d6f-b8ed-87c3fcacf595
          - 53beb701-1231-4548-8abf-c802f38b14aa
    UnusedUserBundlesResponse:
      title: UnusedUserBundlesResponse
      required:
      - data
      type: object
      properties:
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/UnusedUserBundlesSchema'
    UserBundle:
      type: object
      required:
      - id
      - active
      - user_id
      - created_at
      - billing_bundle
      - resources
      properties:
        id:
          type: string
          format: uuid
          example: ca1d2263-d1f1-43ac-ba53-248e7a4bb26a
          description: User bundle's ID, this is used to identify the user bundle in the API.
        active:
          type: boolean
          example: true
          description: Status of the user bundle.
        user_id:
          type: string
          format: uuid
          example: 16856d8c-cd59-4b08-9ac2-1ebb01d419e1
          description: The customer's ID that owns this user bundle.
        created_at:
          type: string
          format: date
          example: '2025-01-20'
          description: Date the user bundle was created.
        updated_at:
          type:
          - string
          - 'null'
          format: date
          example: '2025-01-20'
          description: Date the user bundle was last updated.
        billing_bundle:
          $ref: '#/components/schemas/BillingBundleSummary'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/UserBundleResourceSchema'
          example: []
    CreateUserBundlesBulkRequest:
      properties:
        idempotency_key:
          type: string
          format: uuid
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          description: Idempotency key for the request. Can be any UUID, but should always be unique for each request.
        items:
          type: array
          items:
            type: object
            properties:
              billing_bundle_id:
                type: string
                format: uuid
                example: 12ade33a-21c0-473b-b055-b3c836e1c292
                description: Quantity of user bundles to order.
              quantity:
                type: integer
                description: Quantity of user bundles to order.
            required:
            - billing_bundle_id
            - quantity
          writeOnly: true
      type: object
    UserBundleResourcesResponse:
      title: UserBundleResourcesResponse
      required:
      - data
      type: object
      properties:
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/UserBundleResourceSchema'
    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.
    UserBundleResourceSchema:
      title: UserBundleResourceSchema
      required:
      - id
      - resource
      - resource_type
      - created_at
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: ca1d2263-d1f1-43ac-ba53-248e7a4bb26a
          description: Resource's ID.
        resource:
          type: string
          example: '+15617819942'
          description: The resource itself (usually a phone number).
        resource_type:
          type: string
          example: number
          description: The type of the resource (usually 'number').
        created_at:
          type: string
          format: date
          example: '2025-01-20'
          description: Date the resource was created.
        updated_at:
          type:
          - string
          - 'null'
          format: date
          example: '2025-01-20'
          description: Date the resource was last updated.
    CreatedUserBundlesResponse:
      title: CreatedUserBundlesResponse
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserBundle'
    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
  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_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_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.
    bundle-pricing_UnprocessableEntityErrorResponse:
      description: Request cannot be processed
      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: '10027'
              title: Unprocessable Entity
              detail: The server understood the syntax of the request but was unable to process the instructions.
    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_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_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
    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
    bundle-pricing_UnprocessableEntityErrorResponse_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: Request cannot be processed
    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
  parameters:
    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.
    AuthorizationBearer:
      name: authorization_bearer
      in: header
      schema:
        type: string
        description: Authenticates the request with your Telnyx API V2 KEY
      description: 'Format: Bearer <TOKEN>'
    UserBundleId:
      required: true
      schema:
        title: User Bundle Id
        type: string
        format: uuid
        example: ca1d2263-d1f1-43ac-ba53-248e7a4bb26a
        description: User bundle's ID, this is used to identify the user bundle in the API.
      name: user_bundle_id
      in: path
      description: Unique identifier of the user bundle.
    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.
    UserBundleId_2:
      in: path
      name: user_bundle_id
      required: true
      schema:
        description: User bundle's ID, this is used to identify the user bundle in the API.
        example: ca1d2263-d1f1-43ac-ba53-248e7a4bb26a
        format: uuid
        title: User 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