UpdateSubscription

Content

Description

This callback action is invoked by MarketONE to notify the partner when the user upgrades/downgrades the service subscription via the service provider website.

Note: The digital partner should handle this action to allow for any applicable provisioning.

Request

Parameter Type Required Description
action String(maxSize: 36) Mandatory The action parameter is set to "UpdateSubscription".
endDate Timestamp(format: ISO 8601) Optional The endDate parameter is the end date of the service
partnerSubscriptionId String(maxSize: 256) Mandatory The partnerSubscriptionId parameter is the identifier returned by the "AddSubscription" callback action.
productCode String(maxSize: 15) Mandatory The productId parameter is the partner product purchased by the user.
startDate Timestamp(format: ISO 8601) Optional The startDate parameter is the start date of the subscription.

Response

Parameter Type Required Description
Status: 200 - OK
partnerSubscriptionId String(maxSize: 36) Mandatory The partnerSubscriptionId parameter is the identifier passed in the request.
registrationStatus String(maxSize: 50) Mandatory The registrationStatus parameter is the status of the partner service user registration (ACTIVE, INACTIVE).
startDate Timestamp (format: ISO 8601) Optional The startDate parameter is the date when the access level will be updated. If not returned, the current date is assumed.
Status: 4xx
Error Type Required Description
code String(maxSize: 50) Optional The code is the error for the status.
message String(maxSize: 256) Optional The message is the error description.
Status: 400 - Bad request
Error Code Error Message
invalid-request Invalid request.
parameter-not-supported Not supported.
Status: 401 - Authorization failure
Error Code Error Message
authorization-failure Not authorized.
Status: 403 - Permissions denied
Status: 404 - Not found
Status: 429 - Too many requests
Status: 5xx
Error Type Required Description
code String(maxSize: 50) Optional The code is the error for the service
message String(mazSize: 256) Optional The message is the error description.
Status: 500 - Internal server error
Error Code Error Message
system-error System error.

Example

Request 

POST https://acme.company.com/m1-subscription-events:443 HTTP/1.1
Content-Type: application/json
{
  "action": "UpdateSubscription",
  "partnerSubscriptionId": "123456789",
  "productCode": "123456",
  "startDate": "2019-05-27T05:52:02"
}

Response 

HTTP/1.1 200 OK
{
  "partnerSubscriptionId": "123456789",
  "registrationStatus": "ACTIVE"
}

Note: See the MarketONE Developer Portal for an OpenAPI instance of the MarketONE APIs.

Revision History

Version Description
20.01.01 Added this topic.
20.01.02 Added the startDate parameter to the Status: 200 - OK section of the Response table.
  Added the Status: 5xx and the Status: 500 - Internal server error sections to the Response table.
  Updated the Status: 200 - OK section parameter descriptions in the Response table.