Create User Bundles

POST 
/bundle-pricing/user_bundles/bulk

Creates multiple user bundles for the user.

Header Parameters

Authorization: Bearer <TOKEN> string

application/json

Body

required

idempotency_key uuid

Idempotency key for the request. Can be any UUID, but should always be unique for each request.

items

object[]

Array [

billing_bundle_id uuidrequired

Quantity of user bundles to order.

quantity integerrequired

Quantity of user bundles to order.

]

201: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

required

Array [

id uuidrequired

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

active booleanrequired

Status of the user bundle.

user_id uuidrequired

The customer's ID that owns this user bundle.

created_at daterequired

Date the user bundle was created.

updated_at datenullable

Date the user bundle was last updated.

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

resources

object[]

required

Array [

id uuidrequired

Resource's ID.

resource stringrequired

The resource itself (usually a phone number).

resource_type stringrequired

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

created_at daterequired

Date the resource was created.

updated_at datenullable

Date the resource was last updated.

]

]

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

400: Bad Request

401: Unauthorized

404: Not Found

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/bundle-pricing/user_bundles/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "idempotency_key": "12ade33a-21c0-473b-b055-b3c836e1c292",
  "items": [
    {
      "billing_bundle_id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "quantity": 0
    }
  ]
}'

Response samples

• 201

---

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