Get User Bundles

GET 
/bundle_pricing/user_bundles

Get a paginated list of user bundles.

Query Parameters

filter object

Consolidated filter parameter (deepObject style). Supports filtering by country_iso and resource. Examples: filter[country_iso]=US or filter[resource]=+15617819942

page object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Header Parameters

authorization_bearer string

Format: Bearer

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

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

active booleanrequired

Status of the user bundle.

user_id uuidrequired

The customer's ID that owns this user bundle.

created_at daterequired

Date the user bundle was created.

updated_at datenullable

Date the user bundle was last updated.

billing_bundle

object

required

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[]

resources

object[]

required

Array [

id uuidrequired

Resource's ID.

resource stringrequired

The resource itself (usually a phone number).

resource_type stringrequired

The type of the resource (usually 'number').

created_at daterequired

Date the resource was created.

updated_at datenullable

Date the resource was last updated.

]

]

{
  "meta": {
    "total_results": 55,
    "total_pages": 3,
    "page_number": 2,
    "page_size": 25
  },
  "data": [
    {
      "id": "ca1d2263-d1f1-43ac-ba53-248e7a4bb26a",
      "active": true,
      "user_id": "16856d8c-cd59-4b08-9ac2-1ebb01d419e1",
      "created_at": "2025-01-20",
      "updated_at": "2025-01-20",
      "billing_bundle": {
        "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"
        ]
      },
      "resources": []
    }
  ]
}

401: Unauthorized

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/bundle_pricing/user_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": "ca1d2263-d1f1-43ac-ba53-248e7a4bb26a",
      "active": true,
      "user_id": "16856d8c-cd59-4b08-9ac2-1ebb01d419e1",
      "created_at": "2025-01-20",
      "updated_at": "2025-01-20",
      "billing_bundle": {
        "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"
        ]
      },
      "resources": []
    }
  ]
}