Get Unused User Bundles

Returns all user bundles that aren’t in use.

GET /bundle_pricing/user_bundles/unused

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 response = await client.bundlePricing.userBundles.listUnused();

console.log(response.data);

200

{
  "data": [
    {
      "billing_bundle": {
        "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"
        ]
      },
      "user_bundle_ids": [
        "1e650b96-4c6a-4d6f-b8ed-87c3fcacf595",
        "53beb701-1231-4548-8abf-c802f38b14aa"
      ]
    }
  ]
}

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

Response

200

application/json

Successful Response

data · UnusedUserBundlesSchema · object[] · required

Show child attributes