Get Unused User Bundles

GET 
/bundle-pricing/user_bundles/unused

Returns all User Bundles that aren't in use.

Query Parameters

filter[country_iso] string[]

Filter by country code.

Header Parameters

Authorization: Bearer <TOKEN> string

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

required

Array [

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

user_bundle_ids uuid[]required

List of User Bundle IDs for given Bundle.

]

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

401: Unauthorized

Request samples

• cURL

---

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

Response samples

• 200

---

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