{
"eventId": "b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab",
"type": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"data": {
"orderId": "order-123",
"state": "PENDING",
"lineItems": [
{
"type": "SUBSCRIPTION",
"lineItemId": "line-item-1",
"productOfferingId": "mobile-plan-basic",
"msisdn": "+15551234567",
"leaseToken": "<string>",
"tempNumber": true,
"porting": {
"details": {
"firstName": "<string>",
"lastName": "<string>",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"accountNumber": "<string>",
"passcode": "<string>"
}
},
"extensions": {},
"display": "<string>",
"subscriber": {
"name": "John Doe",
"email": "john.doe@example.com",
"msisdn": "+15551234567",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
}
},
"sim": {
"esim": true,
"imei": "356938035643809",
"iccid": "8931440400000000000"
},
"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": {
"requiresPayment": "NOT_REQUIRED",
"requiresPaymentProfile": "NOT_REQUIRED",
"requiresSigning": "NOT_REQUIRED"
},
"expiresAt": "2024-01-22T10:30:00Z",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:30:00Z",
"user": {
"userId": "c47ac10b-58cc-4372-a567-0e02b2c3d479",
"newUser": true,
"name": "John Doe"
},
"customer": {
"customerType": "CONSUMER",
"name": "John Doe",
"newCustomer": true,
"customerId": "b47ac10b-58cc-4372-a567-0e02b2c3d479"
},
"billing": {
"name": "John Doe",
"email": "billing@example.com",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
}
},
"shipping": {
"name": "John Doe",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"msisdn": "+15551234567",
"instructions": "Leave at front door"
},
"promoCode": "STUDENT2024",
"consents": {
"termsOfService": "true",
"marketing": "true"
},
"pricing": {
"total": 137.39,
"currency": "USD",
"calculatedAt": "2024-01-15T10:30:00Z",
"subtotal": 125.99,
"taxAmount": 10.08,
"fees": 1.32,
"taxIncluded": true,
"recurringCosts": {
"subtotal": 29.99,
"total": 32.39,
"taxAmount": 2.4,
"taxIncluded": true,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"initialInvoice": {
"subtotal": 14.5,
"total": 15.66,
"taxAmount": 123,
"taxIncluded": true,
"period": {
"start": "2024-01-15",
"end": "2024-01-31"
}
}
},
"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>",
"status": "PENDING",
"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>",
"status": "PENDING",
"type": "<string>",
"customerId": "<string>",
"productOfferingId": "<string>",
"activatedAt": "2023-11-07T05:31:56Z",
"createdByLineItem": "g47ac10b-58cc-4372-a567-0e02b2c3d479",
"assignedTo": {
"type": "SUBSCRIPTION",
"subscriptionId": "<string>"
},
"cancelledAt": "2023-11-07T05:31:56Z",
"pausedAt": "2023-12-25"
}
],
"addons": [
{
"status": "PENDING",
"createdByLineItem": "h47ac10b-58cc-4372-a567-0e02b2c3d479",
"productOfferingId": "<string>",
"productOfferingGroupId": "<string>",
"licenseId": "<string>",
"addedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"modifications": [
{
"type": "SUBSCRIPTION_CHANGE",
"targetId": "e8174435-6378-4be5-a9f5-8b4aaadae5d4",
"createdByLineItem": "i47ac10b-58cc-4372-a567-0e02b2c3d479",
"newProductOfferingId": "po_mobile_premium_plus",
"appliedAt": "2023-11-07T05:31:56Z"
}
]
},
"metadata": {}
}
}Sent when an order is formally submitted for processing/fulfillment.
{
"eventId": "b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab",
"type": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"data": {
"orderId": "order-123",
"state": "PENDING",
"lineItems": [
{
"type": "SUBSCRIPTION",
"lineItemId": "line-item-1",
"productOfferingId": "mobile-plan-basic",
"msisdn": "+15551234567",
"leaseToken": "<string>",
"tempNumber": true,
"porting": {
"details": {
"firstName": "<string>",
"lastName": "<string>",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"accountNumber": "<string>",
"passcode": "<string>"
}
},
"extensions": {},
"display": "<string>",
"subscriber": {
"name": "John Doe",
"email": "john.doe@example.com",
"msisdn": "+15551234567",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
}
},
"sim": {
"esim": true,
"imei": "356938035643809",
"iccid": "8931440400000000000"
},
"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": {
"requiresPayment": "NOT_REQUIRED",
"requiresPaymentProfile": "NOT_REQUIRED",
"requiresSigning": "NOT_REQUIRED"
},
"expiresAt": "2024-01-22T10:30:00Z",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:30:00Z",
"user": {
"userId": "c47ac10b-58cc-4372-a567-0e02b2c3d479",
"newUser": true,
"name": "John Doe"
},
"customer": {
"customerType": "CONSUMER",
"name": "John Doe",
"newCustomer": true,
"customerId": "b47ac10b-58cc-4372-a567-0e02b2c3d479"
},
"billing": {
"name": "John Doe",
"email": "billing@example.com",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
}
},
"shipping": {
"name": "John Doe",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"msisdn": "+15551234567",
"instructions": "Leave at front door"
},
"promoCode": "STUDENT2024",
"consents": {
"termsOfService": "true",
"marketing": "true"
},
"pricing": {
"total": 137.39,
"currency": "USD",
"calculatedAt": "2024-01-15T10:30:00Z",
"subtotal": 125.99,
"taxAmount": 10.08,
"fees": 1.32,
"taxIncluded": true,
"recurringCosts": {
"subtotal": 29.99,
"total": 32.39,
"taxAmount": 2.4,
"taxIncluded": true,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"initialInvoice": {
"subtotal": 14.5,
"total": 15.66,
"taxAmount": 123,
"taxIncluded": true,
"period": {
"start": "2024-01-15",
"end": "2024-01-31"
}
}
},
"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>",
"status": "PENDING",
"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>",
"status": "PENDING",
"type": "<string>",
"customerId": "<string>",
"productOfferingId": "<string>",
"activatedAt": "2023-11-07T05:31:56Z",
"createdByLineItem": "g47ac10b-58cc-4372-a567-0e02b2c3d479",
"assignedTo": {
"type": "SUBSCRIPTION",
"subscriptionId": "<string>"
},
"cancelledAt": "2023-11-07T05:31:56Z",
"pausedAt": "2023-12-25"
}
],
"addons": [
{
"status": "PENDING",
"createdByLineItem": "h47ac10b-58cc-4372-a567-0e02b2c3d479",
"productOfferingId": "<string>",
"productOfferingGroupId": "<string>",
"licenseId": "<string>",
"addedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"modifications": [
{
"type": "SUBSCRIPTION_CHANGE",
"targetId": "e8174435-6378-4be5-a9f5-8b4aaadae5d4",
"createdByLineItem": "i47ac10b-58cc-4372-a567-0e02b2c3d479",
"newProductOfferingId": "po_mobile_premium_plus",
"appliedAt": "2023-11-07T05:31:56Z"
}
]
},
"metadata": {}
}
}An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Unique identifier for this event (stable for the logical event; multiple delivery attempts reuse the same id). Use for idempotency.
"b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab"
Event type identifier (dot namespaced, e.g. subscription.created).
"order.submitted"RFC 3339 timestamp when the underlying change occurred.
Order snapshot at submission.
Show child attributes
Acknowledged