DeleteSubscription

Content

Description

This callback action is triggered to notify the partner when the user cancels the subscription, or when the subscription is no longer valid based on the status of their billing account.

Note: The partner must handle this action to allow for any applicable deprovisioning.

Request

Parameter Type Required Description
action String(maxSize: 36) Mandatory The action parameter is set to "DeleteSubscription".
endDate Timestamp(format: ISO 8601) Optional The endDate parameter is the date when the service access expires.
partnerSubscriptionId String(maxSize: 256) Mandatory The partnerSubscriptionId is the partner subscription id previously returned by the "AddSubscription" callback action.

Response

Parameter Type Required Description
Status: 200 - OK
endDate Timestamp(format: ISO 8601) Optional The endDate parameter is the date when the access will be discontinued. If not returned, the current date is assumed.
partnerSubscriptionId String(maxSize: 36) Mandatory The partnerSubscriptionId parameter is the partner subscription id from the request.
registrationStatus String(maxSize: 50) Mandatory The registrationStatus parameter is the current status of the service (INACTIVE).
Note: The partner might choose to discontinue access at the end of the billing cycle.
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": "DeleteSubscription",
  "partnerSubscription": "123456789",
  "endDate": "2019-05-27T05:52:02"
}

Response 

HTTP/1.1 200 OK
{
  "endDate": "2019-05-27T05:52:02",
  "partnerSubscription": "123456789",
  "registrationStatus": "INACTIVE"
}

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 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.