Get Bundle By Id

GET 
/bundle-pricing/billing_bundles/:bundle_id

Get a single bundle by ID.

Path Parameters

billing_bundle_id uuidrequired

Header Parameters

Authorization: Bearer <TOKEN> string

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

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.

active Active (boolean)required

If that bundle is active or not.

is_public Is Public (boolean)required

Available to all customers or only to specific customers.

created_at daterequired

Date the bundle was created.

bundle_limits

object[]

required

Array [

id uuidrequired

service Service (string)required

metric Metric (string)required

limit Limit (integer)

rate Rate (string)

country_iso Country Iso (string)

country_code Country Code (integer)

country Country (string)deprecated

Use country_iso instead

direction BundleLimitDirection (string)

Possible values: [inbound, outbound]

An enumeration.

types string[]

created_at daterequired

updated_at daterequired

billing_service Billing Service (string)

]

{
  "data": {
    "id": "7ecd040e-6bac-4139-9160-3c0427d98fea",
    "name": "Australia Basic",
    "slug": "basic-au-e4f8",
    "cost_code": "BUNDLE-PRICING-BASIC-MRC",
    "active": true,
    "is_public": true,
    "created_at": "2024-07-29",
    "bundle_limits": [
      {
        "id": "e6a32ea9-953b-4622-bbba-9f7bcf7e6717",
        "service": "E911",
        "metric": "number",
        "limit": 1,
        "rate": "5",
        "country_iso": "AU",
        "country_code": 61,
        "direction": "inbound",
        "types": [
          "local"
        ],
        "created_at": "2024-07-29",
        "updated_at": "2024-07-29",
        "billing_service": "emergency"
      }
    ]
  }
}

401: Unauthorized

404: Resource not found

Request samples

• cURL

---

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

Response samples

• 200

---

{
  "data": {
    "id": "7ecd040e-6bac-4139-9160-3c0427d98fea",
    "name": "Australia Basic",
    "slug": "basic-au-e4f8",
    "cost_code": "BUNDLE-PRICING-BASIC-MRC",
    "active": true,
    "is_public": true,
    "created_at": "2024-07-29",
    "bundle_limits": [
      {
        "id": "e6a32ea9-953b-4622-bbba-9f7bcf7e6717",
        "service": "E911",
        "metric": "number",
        "limit": 1,
        "rate": "5",
        "country_iso": "AU",
        "country_code": 61,
        "direction": "inbound",
        "types": [
          "local"
        ],
        "created_at": "2024-07-29",
        "updated_at": "2024-07-29",
        "billing_service": "emergency"
      }
    ]
  }
}