Subscription ended

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: "subscription.ended"

occurredAt

string<date-time>

required

RFC 3339 timestamp when the underlying change occurred.

data

object

required

Final subscription state.

Show child attributes

data.subscriptionId

string

required

The unique identifier for the subscription.

data.status

enum<string>

required

The status of the subscription.

Available options:

PENDING,

ACTIVATED,

BLOCKED,

CANCELLED,

PAUSED

data.type

string

required

The type of subscription, categorizing the service into various telecommunications service types.

data.display

string

required

The display name for the subscription, typically a pretty-print of the msisdn.

data.msisdn

string

required

The currently active phone number for this subscription.

data.customerId

string

required

The unique identifier for the customer who owns this subscription.

data.productOfferingId

string

required

The unique identifier for the product offering associated with this subscription.

data.subscriberId

string

required

The unique identifier for the subscriber associated with this subscription.

data.activatedAt

string<date-time>

required

The date and time when the subscription was activated.

data.createdAt

string<date-time>

required

The date and time when the subscription was created.

data.updatedAt

string<date-time>

required

The date and time when the subscription was last updated.

data.cancelledAt

string<date-time>

The date and time when the subscription was cancelled (if applicable).

Response

Acknowledged

Getting started

Overview

API reference

Authorizations

Body

Response