{
"eventId": "b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab",
"type": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"data": {
"subscriptionId": "<string>",
"status": "PENDING",
"type": "<string>",
"display": "<string>",
"msisdn": "<string>",
"customer": {
"customerId": "<string>",
"name": "<string>"
},
"sim": {
"esim": true,
"imei": "<string>",
"iccid": "<string>"
},
"activatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"productOffering": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"priceType": "ONE_TIME",
"discount": 5,
"netPrice": 5,
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"group": {
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
}
},
"subscriber": {
"subscriberId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"extensions": {},
"pendingMsisdn": {
"msisdn": "<string>",
"scheduledAt": "2023-12-25"
},
"pendingStatus": {
"status": "PENDING",
"scheduledAt": "2023-12-25"
},
"pendingProductOffering": {
"scheduledAt": "2023-12-25",
"product": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"priceType": "ONE_TIME",
"discount": 5,
"netPrice": 5,
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"group": {
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
}
}
},
"porting": {
"msisdn": "<string>",
"status": "PENDING",
"direction": "INBOUND",
"scheduledAt": "2023-12-25"
},
"cancelledAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
}Sent when a subscription reaches its final end (no longer billable / usable).
{
"eventId": "b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab",
"type": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"data": {
"subscriptionId": "<string>",
"status": "PENDING",
"type": "<string>",
"display": "<string>",
"msisdn": "<string>",
"customer": {
"customerId": "<string>",
"name": "<string>"
},
"sim": {
"esim": true,
"imei": "<string>",
"iccid": "<string>"
},
"activatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"productOffering": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"priceType": "ONE_TIME",
"discount": 5,
"netPrice": 5,
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"group": {
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
}
},
"subscriber": {
"subscriberId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"extensions": {},
"pendingMsisdn": {
"msisdn": "<string>",
"scheduledAt": "2023-12-25"
},
"pendingStatus": {
"status": "PENDING",
"scheduledAt": "2023-12-25"
},
"pendingProductOffering": {
"scheduledAt": "2023-12-25",
"product": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"priceType": "ONE_TIME",
"discount": 5,
"netPrice": 5,
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"group": {
"productOfferingGroupId": "mobile-plans",
"name": "Mobile Plans",
"category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
"description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
"internalDescription": "Core mobile offerings targeting consumer and business segments"
}
}
},
"porting": {
"msisdn": "<string>",
"status": "PENDING",
"direction": "INBOUND",
"scheduledAt": "2023-12-25"
},
"cancelledAt": "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).
"subscription.ended"RFC 3339 timestamp when the underlying change occurred.
Final subscription state.
Show child attributes
Acknowledged