Telnyx

Telnyx Billing Groups API

Billing groups operations

GitHub OpenAPI
Business capability
Invoicing & Statement Management BC-4250.30

Operations 5

GET /billing_groups List all billing groups #
POST /billing_groups Create a billing group #
DELETE /billing_groups/{id} Delete a billing group #
GET /billing_groups/{id} Get a billing group #
PATCH /billing_groups/{id} Update a billing group #

Documentation

📖
Documentation
https://developers.telnyx.com/api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/telnyx/openapi/telnyx-billing-groups-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/telnyx/json-schema/telnyx-billing-group-schema.json
📊
JSONSchema
https://artifacts.apis.io/telnyx/json-schema/telnyx-pagination-meta-schema.json
📊
JSONSchema
https://artifacts.apis.io/telnyx/json-schema/telnyx-new-billing-group-schema.json
📊
JSONSchema
https://artifacts.apis.io/telnyx/json-schema/telnyx-update-billing-group-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/telnyx:telnyx-billing-groups-api"
All apis 
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.

Get an API 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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

telnyx-billing-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Telnyx Billing Groups 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 Billing Groups 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: Billing Groups
  description: Billing groups operations
paths:
  /billing_groups:
    get:
      summary: List all billing groups
      deprecated: false
      description: Retrieve a paginated list of billing groups on your account.
      operationId: ListBillingGroups
      tags:
      - Billing Groups
      parameters:
      - name: page
        in: query
        style: deepObject
        explode: true
        description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]'
        schema:
          type: object
          properties:
            number:
              type: integer
              minimum: 1
              default: 1
              description: The page number to load
            size:
              type: integer
              minimum: 1
              maximum: 250
              default: 20
              description: The size of the page
      responses:
        '200':
          description: A paginated array of billing groups
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BillingGroup'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        default:
          $ref: '#/components/responses/GenericErrorResponse'
    post:
      summary: Create a billing group
      deprecated: false
      description: Create a new billing group, which can be used to organize resources for billing purposes.
      operationId: CreateBillingGroup
      tags:
      - Billing Groups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewBillingGroup'
            example:
              name: string
      responses:
        '200':
          description: Expected billing group response to a valid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BillingGroup'
          headers: {}
        '409':
          $ref: '#/components/responses/ConflictErrorResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityErrorResponse'
        default:
          $ref: '#/components/responses/GenericErrorResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /billing_groups/{id}:
    delete:
      summary: Delete a billing group
      deprecated: false
      description: Delete a billing group from your account.
      operationId: DeleteBillingGroup
      tags:
      - Billing Groups
      parameters:
      - name: id
        in: path
        description: The id of the billing group
        required: true
        example: f5586561-8ff0-4291-a0ac-84fe544797bd
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Expected billing group response to a valid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BillingGroup'
          headers: {}
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '409':
          $ref: '#/components/responses/ConflictErrorResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityErrorResponse'
        default:
          $ref: '#/components/responses/GenericErrorResponse'
    get:
      summary: Get a billing group
      deprecated: false
      description: Retrieve the details of a specific billing group.
      operationId: GetBillingGroup
      tags:
      - Billing Groups
      parameters:
      - name: id
        in: path
        description: The id of the billing group
        required: true
        example: f5586561-8ff0-4291-a0ac-84fe544797bd
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Expected billing group response to a valid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BillingGroup'
          headers: {}
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        default:
          $ref: '#/components/responses/GenericErrorResponse'
    patch:
      summary: Update a billing group
      deprecated: false
      description: Update the properties of an existing billing group.
      operationId: UpdateBillingGroup
      tags:
      - Billing Groups
      parameters:
      - name: id
        in: path
        description: The id of the billing group
        required: true
        example: f5586561-8ff0-4291-a0ac-84fe544797bd
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBillingGroup'
            example:
              name: string
      responses:
        '200':
          description: Expected billing group response to a valid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BillingGroup'
          headers: {}
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityErrorResponse'
        default:
          $ref: '#/components/responses/GenericErrorResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  responses:
    ForbiddenErrorResponse:
      description: Insufficient permissions to access billing group
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    NotFoundErrorResponse:
      description: Billing group not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    ConflictErrorResponse:
      description: Resource conflict or in use
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    GenericErrorResponse:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    UnprocessableEntityErrorResponse:
      description: Invalid request data
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    BadRequestErrorResponse:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    GenericErrorResponse_2:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/billing_Errors'
      description: Unexpected error
    BadRequestErrorResponse_2:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/invoice_Errors'
      description: Invalid request parameters
  schemas:
    Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/billing-group_Error'
      type: object
    UpdateBillingGroup:
      type: object
      properties:
        name:
          type: string
          description: A name for the billing group
      example:
        name: string
    BillingGroup:
      type: object
      properties:
        record_type:
          type: string
          enum:
          - billing_group
          description: Identifies the type of the resource.
          example: billing_group
        id:
          type: string
          format: uuid
          description: Identifies the type of resource.
          example: f5586561-8ff0-4291-a0ac-84fe544797bd
        organization_id:
          type: string
          format: uuid
          description: Identifies the organization that owns the resource.
          example: f1486bae-f067-460c-ad43-73a92848f902
        name:
          type: string
          description: A user-specified name for the billing group
          example: My billing group name
        created_at:
          type: string
          format: date-time
          description: ISO 8601 formatted date indicating when the resource was created.
          example: '2019-10-15T10:07:15.527Z'
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: '2019-10-15T10:07:15.527Z'
        deleted_at:
          type:
          - string
          - 'null'
          format: date-time
          description: ISO 8601 formatted date indicating when the resource was removed.
          example: null
      example:
        record_type: billing_group
        id: f5586561-8ff0-4291-a0ac-84fe544797bd
        organization_id: f1486bae-f067-460c-ad43-73a92848f902
        name: My billing group name
        created_at: '2019-10-15T10:07:15.527Z'
        updated_at: '2019-10-15T10:07:15.527Z'
        deleted_at: null
    NewBillingGroup:
      type: object
      properties:
        name:
          type: string
          description: A name for the billing group
      example:
        name: string
    PaginationMeta:
      type: object
      properties:
        total_pages:
          type: integer
          example: 3
        total_results:
          type: integer
          example: 55
        page_number:
          type: integer
          example: 2
        page_size:
          type: integer
          example: 25
    billing-group_Error:
      type: object
      required:
      - code
      - title
      properties:
        code:
          type: integer
          format: int32
        title:
          type: string
        detail:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          properties: {}
          additionalProperties: true
    billing_Error:
      properties:
        code:
          type: string
        detail:
          type: string
        meta:
          additionalProperties: true
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
          type: object
        title:
          type: string
      required:
      - code
      - title
      type: object
    invoice_Error:
      properties:
        code:
          type: string
        detail:
          type: string
        meta:
          additionalProperties: true
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
          type: object
        title:
          type: string
      required:
      - code
      - title
      type: object
    invoice_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/invoice_Error'
          type: array
      type: object
    billing_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/billing_Error'
          type: array
      type: object
    Errors_2:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      type: object
    Error:
      required:
      - code
      - title
      properties:
        code:
          type: string
          x-format: int64
        title:
          type: string
        detail:
          type: string
          description: A human-readable explanation of the error.
        description:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              format: json-pointer
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          additionalProperties: true
      example:
        title: Invalid street address
        source:
          pointer: /street_address
        code: '20207'
        description: The street address provided is invalid.
      type: object
  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