Retrieve Bundles

GET 
/bundle-pricing/billing_bundles

Get all allowed bundles.

Query Parameters

filter[country_iso] string[]

Filter by country code.

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load.

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page.

Header Parameters

Authorization: Bearer <TOKEN> string

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

meta

object

required

total_results Total Results (integer)required

Total number of results returned.

total_pages Total Pages (integer)required

Total number of pages from the results.

page_number Page Number (integer)required

The current page number.

page_size Page Size (integer)required

The number of results per page.

data

object[]

required

Array [

id uuidrequired

Bundle's ID, this is used to identify the bundle in the API.

name Name (string)required

Bundle's name, this is used to identify the bundle in the UI.

slug Slug (string)

Slugified version of the bundle's name.

cost_code Cost Code (string)required

Bundle's cost code, this is used to identify the bundle in the billing system.

is_public Is Public (boolean)required

Available to all customers or only to specific customers.

created_at daterequired

Date the bundle was created.

mrc_price float

Monthly recurring charge price.

currency Currency (string)

Bundle's currency code.

specs string[]

]

{
  "meta": {
    "total_results": 55,
    "total_pages": 3,
    "page_number": 2,
    "page_size": 25
  },
  "data": [
    {
      "id": "7ecd040e-6bac-4139-9160-3c0427d98fea",
      "name": "Australia Basic",
      "slug": "basic-au-e4f8",
      "cost_code": "BUNDLE-PRICING-BASIC-MRC",
      "is_public": true,
      "created_at": "2024-07-29",
      "mrc_price": 2,
      "currency": "USD",
      "specs": [
        "1 AU Number",
        "Emergency Calling",
        "All inbound and outbound calling billed pay-as-you-go"
      ]
    }
  ]
}

401: Unauthorized

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/bundle-pricing/billing_bundles' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200

---

{
  "meta": {
    "total_results": 55,
    "total_pages": 3,
    "page_number": 2,
    "page_size": 25
  },
  "data": [
    {
      "id": "7ecd040e-6bac-4139-9160-3c0427d98fea",
      "name": "Australia Basic",
      "slug": "basic-au-e4f8",
      "cost_code": "BUNDLE-PRICING-BASIC-MRC",
      "is_public": true,
      "created_at": "2024-07-29",
      "mrc_price": 2,
      "currency": "USD",
      "specs": [
        "1 AU Number",
        "Emergency Calling",
        "All inbound and outbound calling billed pay-as-you-go"
      ]
    }
  ]
}