Skip to main content
POST
Error

Authorizations

X-API-KEY
string
header
required

The authorization key obtained from the OTT service provider for a given CSP organization.

Headers

X-B3-TraceId
string

The TraceId indicates the overall ID of the trace. Every span in a trace shares this ID. The X-B3-TraceId header is encoded as 32 or 16 lower-hex characters. For example, a 128-bit TraceId header might look like 463ac35c9f6413ad48485a3953bb6124.

X-B3-SpanId
string

The SpanId is 64-bit in length and indicates the position of the current operation in the trace tree. The value should not be interpreted; it may or may not be derived from the value of the TraceId. The X-B3-SpanId header is encoded as 16 lower-hex characters. For example, a SpanId header might look like a2fb4a1d1a96d312. Unless propagating only the Sampling State, the X-B3-SpanId header is required.

X-B3-ParentSpanId
string

The ParentSpanId is 64-bit in length and indicates the position of the parent operation in the trace tree. When the span is the root of the trace tree, there is no ParentSpanId. The X-B3-ParentSpanId header may be present on a child span and must be absent on the root span. It is encoded as 16 lower-hex characters. For example, a ParentSpanId header might look like 0020000000000001.

Body

application/json

A Callback Request will contain an "action" parameter. Action Parameter can be "AddSubscription", "DeleteSubscription", "UpdateSubscription", "PauseSubscription", "ResumeSubscription". Please note that callbacks must be idempotent; e.g "AddSubscription" if a record already exist for a subscriptionId, a new OTT service provider subscription record should not be created but rather updated with new registration code; "DeleteSubscription" if a record was already deleted, return OK, "UpdateSubscriptionMetadata" If only metadata on subscription changed etc.

action
enum<string>
required
Available options:
SubscriptionTrialEnding
partnerSubscriptionId
string
required

The unique identifier for the provisioning record

Maximum string length: 256
partnerCustomerId
string
required

The unique identifier for the partner customer account

Maximum string length: 256
subscriptionId
string

The id of a MarketONE subscription.Will be sent in the request call for "PauseSubscription"

Maximum string length: 128
externalPartnerSubscriptionId
string

A OTT service provider specific ID that identifies the OTT service subscription. This id is returned during initial provisioning. Required for "UpdateSubscription" and "DeleteSubscription","PauseSubscription" callbacks.

Maximum string length: 256
organizationCode
string

The organization code for the aggregator

Maximum string length: 128
productCode
string

the merchant product code which is subscribed by the customer as defined by the Merchant in MarketONE for which there is a MarketONE agreement.

Maximum string length: 128
trialEndDate
string<date-time>

The start date of the subscription pause (ISO 8601 ).

Response

200

OK