Skip to main content
WEBHOOK
order.lineItemStatusChanged
{
  "eventId": "b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab",
  "type": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "data": {
    "order": {
      "orderId": "order-123",
      "lineItems": [
        {
          "lineItemId": "line-item-1",
          "productOfferingId": "mobile-plan-basic",
          "msisdn": "+15551234567",
          "leaseToken": "<string>",
          "tempNumber": true,
          "portingRequested": true,
          "extensions": {},
          "display": "<string>",
          "subscriber": {
            "name": "John Doe",
            "email": "john.doe@example.com",
            "msisdn": "+15551234567"
          },
          "scheduleActivationAt": "2024-02-01",
          "metadata": {}
        }
      ],
      "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": {},
      "expiresAt": "2024-01-22T10:30:00Z",
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "billing": {
        "name": "John Doe",
        "email": "billing@example.com"
      },
      "promoCode": "STUDENT2024",
      "consents": {
        "termsOfService": "true",
        "marketing": "true"
      },
      "externalPayment": {
        "reference": "ext-payment-ref-123",
        "receiptDescription": "Payment via external billing system",
        "receiptUrl": "https://external.example.com/receipts/123",
        "receivedAt": "2024-01-15T14:30:00Z"
      },
      "submittedAt": "2024-01-15T14:30:00Z",
      "completedAt": "2024-01-15T15:00:00Z",
      "createdEntities": {
        "subscriptions": [
          {
            "subscriptionId": "<string>",
            "type": "<string>",
            "display": "<string>",
            "msisdn": "<string>",
            "customerId": "<string>",
            "productOfferingId": "<string>",
            "subscriberId": "<string>",
            "activatedAt": "2023-11-07T05:31:56Z",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "createdByLineItem": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
            "cancelledAt": "2023-11-07T05:31:56Z"
          }
        ],
        "licenses": [
          {
            "licenseId": "<string>",
            "type": "<string>",
            "customerId": "<string>",
            "productOfferingId": "<string>",
            "activatedAt": "2023-11-07T05:31:56Z",
            "createdByLineItem": "g47ac10b-58cc-4372-a567-0e02b2c3d479",
            "cancelledAt": "2023-11-07T05:31:56Z",
            "pausedAt": "2023-12-25"
          }
        ],
        "addons": [
          {
            "createdByLineItem": "h47ac10b-58cc-4372-a567-0e02b2c3d479",
            "productOfferingId": "<string>",
            "referenceId": "telna-package-12345",
            "productOfferingGroupId": "<string>",
            "licenseId": "<string>",
            "addedAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "cancelledAt": "2023-11-07T05:31:56Z",
            "metadata": {}
          }
        ],
        "modifications": [
          {
            "targetId": "e8174435-6378-4be5-a9f5-8b4aaadae5d4",
            "createdByLineItem": "i47ac10b-58cc-4372-a567-0e02b2c3d479",
            "newProductOfferingId": "po_mobile_premium_plus",
            "appliedAt": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "metadata": {}
    },
    "lineItemId": "line-item-1"
  }
}

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.

Body

application/json
​
eventId
string<uuid>
required

Unique identifier for this event (stable for the logical event; multiple delivery attempts reuse the same id). Use for idempotency.

Example:

"b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab"

​
type
string
required

Event type identifier (dot namespaced, e.g. subscription.created).

Allowed value: "order.lineItemStatusChanged"
​
occurredAt
string<date-time>
required

RFC 3339 timestamp when the underlying change occurred.

​
data
object
required

Event-specific payload; structure depends on event type.

Response

Acknowledged