Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const response = await client.bundlePricing.userBundles.deactivate('ca1d2263-d1f1-43ac-ba53-248e7a4bb26a'); console.log(response.data);

{ "data": { "id": "ca1d2263-d1f1-43ac-ba53-248e7a4bb26a", "active": true, "user_id": "16856d8c-cd59-4b08-9ac2-1ebb01d419e1", "created_at": "2025-01-20", "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" ] }, "resources": [], "updated_at": "2025-01-20" } }

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 <TOKEN> Authenticates the request with your Telnyx API V2 KEY

Path Parameters

user_bundle_id

string<uuid>

required

User bundle's ID, this is used to identify the user bundle in the API.

Example:

"ca1d2263-d1f1-43ac-ba53-248e7a4bb26a"

Response

Successful Response

data

object

required

Show child attributes

data.id

string<uuid>

required

User bundle's ID, this is used to identify the user bundle in the API.

Example:

"ca1d2263-d1f1-43ac-ba53-248e7a4bb26a"

data.active

boolean

required

Status of the user bundle.

Example:

true

data.user_id

string<uuid>

required

The customer's ID that owns this user bundle.

Example:

"16856d8c-cd59-4b08-9ac2-1ebb01d419e1"

data.created_at

string<date>

required

Date the user bundle was created.

Example:

"2025-01-20"

data.billing_bundle

BillingBundleSummary · object

required

Show child attributes

data.billing_bundle.id

string<uuid>

required

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

Example:

"7ecd040e-6bac-4139-9160-3c0427d98fea"

data.billing_bundle.name

string

required

Bundle's name, this is used to identify the bundle in the UI.

Example:

"Australia Basic"

data.billing_bundle.cost_code

string

required

Bundle's cost code, this is used to identify the bundle in the billing system.

Example:

"BUNDLE-PRICING-BASIC-MRC"

data.billing_bundle.is_public

boolean

required

Available to all customers or only to specific customers.

data.billing_bundle.created_at

string<date>

required

Date the bundle was created.

data.billing_bundle.slug

string

Slugified version of the bundle's name.

Example:

"basic-au-e4f8"

data.billing_bundle.mrc_price

number<float>

Monthly recurring charge price.

Example:

2

data.billing_bundle.currency

string

Bundle's currency code.

Example:

"USD"

data.billing_bundle.specs

string[]

Example:

[
  "1 AU Number",
  "Emergency Calling",
  "All inbound and outbound calling billed pay-as-you-go"
]

data.resources

UserBundleResourceSchema · object[]

required

Show child attributes

data.resources.id

string<uuid>

required

Resource's ID.

Example:

"ca1d2263-d1f1-43ac-ba53-248e7a4bb26a"

data.resources.resource

string

required

The resource itself (usually a phone number).

Example:

"+15617819942"

data.resources.resource_type

string

required

The type of the resource (usually 'number').

Example:

"number"

data.resources.created_at

string<date>

required

Date the resource was created.

Example:

"2025-01-20"

data.resources.updated_at

string<date> | null

Date the resource was last updated.

Example:

"2025-01-20"

Example:

[]

data.updated_at

string<date> | null

Date the user bundle was last updated.

Example:

"2025-01-20"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup