Skip to main content
POST
/
orders
/
{orderId}
/
line-items
{
  "type": "SUBSCRIPTION",
  "lineItemId": "line-item-1",
  "productOfferingId": "mobile-plan-basic",
  "msisdn": "+15551234567",
  "leaseToken": "<string>",
  "tempNumber": true,
  "porting": {
    "details": {
      "accountNumber": "<string>",
      "passcode": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "address": {
        "street1": "500 S Main St",
        "street2": "Apt 1",
        "city": "Natick",
        "zip": "01701",
        "country": "US",
        "state": "CA",
        "region": "<string>",
        "attention": "<string>"
      }
    }
  },
  "extensions": {},
  "display": "<string>",
  "subscriber": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "msisdn": "+15551234567",
    "identity": "<string>"
  },
  "sim": {
    "esim": true,
    "imei": "356938035643809",
    "iccid": "8931440400000000000"
  },
  "scheduleActivationAt": "2024-02-01",
  "metadata": {}
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum length: 256

Path Parameters

​
orderId
string
required

The unique identifier of the order

Body

application/json

Request to add a line item to an order.

​
lineItem
object
required

A line item in an order representing a billable action or service. Create a new subscription in this order. This will set up a new phone service for a customer with their chosen plan and phone number.

  • Subscription
  • License
  • Add-on
  • Top-up
  • External Product
  • External Item
  • Subscription Change
  • License Change
  • Add-on Change

Response

Line item added successfully

  • Subscription
  • License
  • Add-on
  • Top-up
  • External Product
  • External Item
  • Subscription Change
  • License Change
  • Add-on Change

A line item in an order representing a billable action or service. Create a new subscription in this order. This will set up a new phone service for a customer with their chosen plan and phone number.

​
type
enum<string>
required

Line item type discriminator.

Available options:
SUBSCRIPTION
​
lineItemId
string
required

Unique identifier for this line item within the order.

Example:

"line-item-1"

​
productOfferingId
string
required

The product offering to create a subscription for.

Example:

"mobile-plan-basic"

​
msisdn
string

The phone number for this subscription.

  • Leave empty to have one assigned.
  • When the number pool is available, you can choose a number from the pool and provide the leaseToken.
  • When porting a number, provide the number and porting details.
Example:

"+15551234567"

​
leaseToken
string

Token received when leasing a number. Required when an msisdn is provided from the number pool.

​
tempNumber
boolean

Whether to use a temporary number until the porting is completed.

If true, a temporary number will be assigned and activated as soon as possible until the porting is finalized.

Can only be used when porting in a number (i.e., when msisdn and porting details are provided).

​
porting
object

Details needed to port in a number for this subscription.

​
extensions
object

Additional subscription extensions fields for custom subscription types.

​
display
string

Custom display name for the subscription. If not provided, will be auto-generated from msisdn.

​
subscriber
object

Subscriber information (required eventually).

​
sim
object

SIM configuration (required eventually).

​
scheduleActivationAt
string<date>

Date when the subscription should be activated.

Example:

"2024-02-01"

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

⌘I