Skip to main content
POST
/
orders
/
{orderId}
/
submit
{
  "order": {
    "orderId": "order-123",
    "status": "PENDING",
    "user": {
      "userId": "c47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "John Doe",
      "newUser": true
    },
    "customer": {
      "customerId": "b47ac10b-58cc-4372-a567-0e02b2c3d479",
      "customerType": "CONSUMER",
      "name": "John Doe",
      "newCustomer": true
    },
    "billing": {
      "name": "John Doe",
      "email": "billing@example.com",
      "address": {
        "street1": "500 S Main St",
        "street2": "Apt 1",
        "city": "Natick",
        "zip": "01701",
        "country": "US",
        "state": "CA",
        "region": "<string>",
        "attention": "<string>"
      }
    },
    "shipping": {
      "name": "John Doe",
      "msisdn": "+15551234567",
      "address": {
        "street1": "500 S Main St",
        "street2": "Apt 1",
        "city": "Natick",
        "zip": "01701",
        "country": "US",
        "state": "CA",
        "region": "<string>",
        "attention": "<string>"
      },
      "instructions": "Leave at front door"
    },
    "promoCode": "STUDENT2024",
    "consents": {
      "termsOfService": "true",
      "marketing": "true"
    },
    "lineItems": [
      {
        "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": {}
      }
    ],
    "pricing": {
      "subtotal": 125.99,
      "taxAmount": 10.08,
      "fees": 1.32,
      "total": 137.39,
      "taxIncluded": true,
      "currency": "USD",
      "recurringCosts": {
        "subtotal": 29.99,
        "total": 32.39,
        "taxAmount": 2.4,
        "taxIncluded": true,
        "billingCycle": {
          "period": "<any>",
          "interval": "<any>"
        }
      },
      "initialInvoice": {
        "subtotal": 14.5,
        "total": 15.66,
        "taxAmount": 123,
        "taxIncluded": true,
        "period": {
          "start": "2024-01-15",
          "end": "2024-01-31"
        }
      },
      "lineItemPricing": [
        {
          "lineItemId": "e47ac10b-58cc-4372-a567-0e02b2c3d479",
          "description": "iPhone 15 Pro + Premium Plan",
          "amount": 999,
          "taxAmount": 79.92,
          "taxIncluded": true,
          "taxBreakdown": [
            {
              "description": "Sales Tax",
              "amount": 2.4,
              "rate": 8.25
            }
          ],
          "recurringAmount": 29.99,
          "initialInvoiceAmount": 14.5
        }
      ],
      "calculatedAt": "2024-01-15T10:30:00Z"
    },
    "validation": {
      "isValid": false,
      "missingFields": [
        "customer",
        "billing.address"
      ],
      "errors": [
        {
          "message": "<string>",
          "property": "<string>"
        }
      ],
      "lineItemValidation": [
        {
          "lineItemId": "line-item-1",
          "isValid": false,
          "missingFields": [
            "subscriber.name",
            "sim.iccid"
          ],
          "errors": [
            {
              "message": "<string>",
              "property": "<string>"
            }
          ]
        }
      ]
    },
    "requirements": {
      "requiresPayment": "NOT_REQUIRED",
      "requiresPaymentProfile": "NOT_REQUIRED",
      "requiresSigning": "NOT_REQUIRED"
    },
    "expiresAt": "2024-01-22T10:30:00Z",
    "submittedAt": "2024-01-15T14:30:00Z",
    "completedAt": "2024-01-15T15:00:00Z",
    "createdEntities": {
      "subscriptions": [
        {
          "subscriptionId": "c9a4d8d4-24c0-4164-ac8d-c77c4103b786",
          "status": "PENDING",
          "display": "+1 (555) 123-4567",
          "msisdn": "+15551234567",
          "productOfferingId": "<string>",
          "productOffering": {
            "productOfferingId": "<string>",
            "name": "<string>",
            "price": {
              "grossPrice": 10,
              "discount": 123,
              "netPrice": 5,
              "currency": "USD",
              "priceType": "ONE_TIME",
              "boundMonths": 12,
              "billingCycle": {
                "period": "<any>",
                "interval": "<any>"
              },
              "taxIncluded": true
            },
            "productOfferingGroupId": "<string>",
            "group": {
              "productOfferingGroupId": "<string>",
              "name": "<string>",
              "category": "SUBSCRIPTION_CELL"
            }
          },
          "customerId": "<string>",
          "customer": {
            "customerId": "<string>",
            "name": "<string>"
          },
          "subscriberId": "<string>",
          "subscriber": {
            "subscriberId": "<string>",
            "name": "<string>",
            "email": "jsmith@example.com",
            "address": {
              "street1": "500 S Main St",
              "street2": "Apt 1",
              "city": "Natick",
              "zip": "01701",
              "country": "US",
              "state": "CA",
              "region": "<string>",
              "attention": "<string>"
            },
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "activatedAt": "2024-01-15T10:30:00Z",
          "createdByLineItem": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
        }
      ],
      "licenses": [
        {
          "licenseId": "b3c4d5e6-f7a8-9012-3456-789012345678",
          "status": "PENDING",
          "type": "<string>",
          "productOfferingId": "<string>",
          "productOffering": {
            "productOfferingId": "<string>",
            "name": "<string>",
            "price": {
              "grossPrice": 10,
              "discount": 123,
              "netPrice": 5,
              "currency": "USD",
              "priceType": "ONE_TIME",
              "boundMonths": 12,
              "billingCycle": {
                "period": "<any>",
                "interval": "<any>"
              },
              "taxIncluded": true
            },
            "productOfferingGroupId": "<string>",
            "group": {
              "productOfferingGroupId": "<string>",
              "name": "<string>",
              "category": "SUBSCRIPTION_CELL"
            }
          },
          "assignedTo": {
            "type": "SUBSCRIPTION",
            "subscriptionId": "<string>",
            "subscriptionDisplay": "<string>"
          },
          "customerId": "<string>",
          "customer": {
            "customerId": "<string>",
            "name": "<string>"
          },
          "activatedAt": "2024-01-15T10:30:00Z",
          "createdByLineItem": "g47ac10b-58cc-4372-a567-0e02b2c3d479"
        }
      ],
      "addons": [
        {
          "productOfferingId": "<string>",
          "productOffering": {
            "productOfferingId": "<string>",
            "name": "<string>",
            "price": {
              "grossPrice": 10,
              "discount": 123,
              "netPrice": 5,
              "currency": "USD",
              "priceType": "ONE_TIME",
              "boundMonths": 12,
              "billingCycle": {
                "period": "<any>",
                "interval": "<any>"
              },
              "taxIncluded": true
            },
            "productOfferingGroupId": "<string>",
            "group": {
              "productOfferingGroupId": "<string>",
              "name": "<string>",
              "category": "SUBSCRIPTION_CELL"
            }
          },
          "status": "PENDING",
          "productOfferingGroupId": "<string>",
          "group": {
            "productOfferingGroupId": "<string>",
            "name": "<string>",
            "category": "SUBSCRIPTION_CELL"
          },
          "licenseId": "<string>",
          "pendingStatus": {
            "status": "PENDING",
            "scheduledAt": "2023-12-25"
          },
          "addedAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "cancelledAt": "2023-11-07T05:31:56Z",
          "metadata": {},
          "createdByLineItem": "h47ac10b-58cc-4372-a567-0e02b2c3d479"
        }
      ],
      "modifications": [
        {
          "type": "SUBSCRIPTION_CHANGE",
          "targetId": "e8174435-6378-4be5-a9f5-8b4aaadae5d4",
          "newProductOfferingId": "po_mobile_premium_plus",
          "appliedAt": "2023-11-07T05:31:56Z",
          "createdByLineItem": "i47ac10b-58cc-4372-a567-0e02b2c3d479"
        }
      ]
    },
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "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 submit an order for fulfillment.

Depending on the order's requirements, payment intent, saved payment profile, or signing reference may be required.

In a fully managed flow, the order may be auto-submitted on successfully fulfilling all requirements (e.g. successful payment or signing).

​
paymentSessionId
string

Reference to completed payment session for orders requiring payment collection.

Example:

"a1b2c3d4-e5f6-7890-1234-56789abcdef0"

​
paymentProfileSessionId
string

Reference to completed payment profile session for zero-total orders requiring payment method setup.

Example:

"b2c3d4e5-f6a7-8901-2345-6789abcdef01"

​
signingSessionId
string

Reference to completed signing session.

Example:

"c3d4e5f6-a7b8-9012-3456-789abcdef012"

​
metadata
object

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

Response

Order submitted successfully

​
order
object
required

A shopping cart for telecommunications services and products. Add line items to configure services, get pricing, and submit for fulfillment. Orders track progress from creation through completion.

⌘I