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

occurredAt

string<date-time>

required

RFC 3339 timestamp when the underlying change occurred.

data

object

required

Final license snapshot.

Show child attributes

data.licenseId

string

required

The unique identifier for the license.

data.status

enum<string>

required

The status of the license.

Available options:

PENDING,

ACTIVE,

PAUSED,

CANCELLED,

BLOCKED

data.type

string

required

The type of license, categorizing the software product or service into various telecommunications license types.

data.customerId

string

required

The unique identifier for the customer who owns this license.

data.productOfferingId

string

required

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

data.activatedAt

string<date-time>

required

The date when the license was activated.

data.assignedTo

Subscription · object

Assignment reference for a license, indicating what entity the license is assigned to. This is a simplified version for list operations - use EmbeddedAssignedTo for detailed views.

Show child attributes

data.assignedTo.type

enum<string>

required

Available options:

SUBSCRIPTION

data.assignedTo.subscriptionId

string

required

data.cancelledAt

string<date-time>

The date when the license was cancelled (if applicable).

data.pausedAt

string<date>

The date when the license was paused (if applicable).

Response

Acknowledged

Getting started

Overview

API reference

Authorizations

Body

Response