A valid request URL is required to generate request examples{
"subscriptionId": "<string>",
"partnerSubscriptionId": "<string>",
"registrationStatus": "INACTIVE",
"partnerCustomerId": "<string>",
"externalPartnerSubscriptionId": "<string>",
"registrationString": "<string>",
"redemptionCodeExpirationTime": "<string>"
}{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authorization-failure",
"message": "<string>"
}{
"code": "forbidden",
"message": "<string>"
}{
"code": "not-found",
"message": "<string>"
}{
"code": "input-conflict",
"message": "<string>"
}{
"code": "too-many-requests",
"message": "<string>"
}{
"code": "system-error",
"message": "<string>"
}{
"code": "service-unavailable",
"message": "<string>"
}Service Provisioning Callbacks
Callbacks allow a OTT service provider system to know about MarketONE service provisioning events as they occur. You can provide a callback URL and when those events happen, MarketONE will immediately generate an HTTPS POST request with a JSON payload. MarketONE callback actions are intended to be actionable on their own. As such they will include the full related object(s) in JSON format.
A valid request URL is required to generate request examples{
"subscriptionId": "<string>",
"partnerSubscriptionId": "<string>",
"registrationStatus": "INACTIVE",
"partnerCustomerId": "<string>",
"externalPartnerSubscriptionId": "<string>",
"registrationString": "<string>",
"redemptionCodeExpirationTime": "<string>"
}{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authorization-failure",
"message": "<string>"
}{
"code": "forbidden",
"message": "<string>"
}{
"code": "not-found",
"message": "<string>"
}{
"code": "input-conflict",
"message": "<string>"
}{
"code": "too-many-requests",
"message": "<string>"
}{
"code": "system-error",
"message": "<string>"
}{
"code": "service-unavailable",
"message": "<string>"
}Authorizations
The authorization key obtained from the OTT service provider for a given CSP organization.
Headers
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.
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.
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
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.
The id of a MarketONE subscription.Will be sent in the request call for "AddSubscription"
128The unique identifier for the provisioning record
256The organization code for the aggregator
128The code of the OTT service provider product subscribed by the customer as defined by the OTT service provider in MarketONE for which there is an MarketONE agreement in place. This parameter is required in the "UpdateSubscription" and "AddSubscription" cases while creating, upgrading or downgrading to a different service as the new product code.
128(Optional) The start date of the subscription (ISO 8601).
AddSubscription The unique identifier for the partner customer account
256This is information that can be used by the OTT service provider to associate this subscription with a user. This can be an access code, access token or redemption code. This parameter is applicable only to the "AddSubscription" callback.
(Optional) The time at which the redemption code (registration string) expires (ISO 8601).
(Optional) the unit quanity for the subscription
A set of key/value pairs that you can attach to an object. Useful for storing additional information.
Show child attributes
Show child attributes
Response
OK
The id of a MarketONE subscription.
128The unique identifier for the provisioning record
256The status of the OTT service entitlements linking to a user, usually INACTIVE after an "AddSubscription" callback.
INACTIVE, ACTIVE The unique identifier for the partner customer account
256The OTT service provider id that uniquely identitifes the OTT service entitlements and it is associated to this MarketONE subscriptionId.
256This is information that can be used by the OTT service provider to associate this subscription with a user. This can be an access code, access token or redemption code. This parameter is applicable only to the "AddSubscription" callback.
(Optional) The time at which the redemption code (registration string) expires (ISO 8601).
Was this page helpful?