Get Bundle By Id

Get a single bundle by ID.

GET /bundle_pricing/billing_bundles/{bundle_id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const billingBundle = await client.bundlePricing.billingBundles.retrieve(
  '8661948c-a386-4385-837f-af00f40f111a',
);

console.log(billingBundle.data);

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization_bearer · string

Format: Bearer Authenticates the request with your Telnyx API V2 KEY

Path Parameters

bundle_id · string<uuid> · required

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

Example:

"8661948c-a386-4385-837f-af00f40f111a"

Response

200

application/json

Successful Response

data · BillingBundleSchema · object · required

Show child attributes