Create billing plan

POST 
/wireless/billing_plans

Creates a new billing plan. The billing plan name must be unique.

Request

application/json

Body

required

Create billing plan

data_allocation_per_sim integer

How much data can each SIM card consume

default boolean

Is the billing plan the default billing plan

name string

The name of the billing plan

regions string[]

The regions for which this billing plan applies

type string

The type of billing plan

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

The id of the billing plan

data_allocation_per_sim integer

How much data can each SIM card consume

default boolean

Is the billing plan the default billing plan

inserted_at string

When was the billing plan created

name string

The name of the billing plan

regions string[]

The regions for which this billing plan applies

type string

The type of billing plan

updated_at string

When was the billing plan last updated

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "data_allocation_per_sim": 0,
    "default": true,
    "inserted_at": "string",
    "name": "string",
    "regions": [
      "string"
    ],
    "type": "string",
    "updated_at": "string"
  }
}

401: Authentication error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

403: Authorization error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/wireless/billing_plans' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "data_allocation_per_sim": 0,
  "default": true,
  "name": "string",
  "regions": [
    "string"
  ],
  "type": "string"
}'

Response samples

• 200
• 401
• 403

---

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "data_allocation_per_sim": 0,
    "default": true,
    "inserted_at": "string",
    "name": "string",
    "regions": [
      "string"
    ],
    "type": "string",
    "updated_at": "string"
  }
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}