Retrieve Bundles

Get all allowed bundles.

GET /bundle_pricing/billing_bundles

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const billingBundleSummary of client.bundlePricing.billingBundles.list()) {
  console.log(billingBundleSummary.id);
}

200

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

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

Query Parameters

filter · object

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

Show child attributes

page · object

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

Show child attributes

Response

200

application/json

Successful Response

meta · PaginationResponse · object · required

Show child attributes

data · BillingBundleSummary · object[] · required

Show child attributes