Entitlement reactivation API

POST https://resale.api.bango.net/v1/entitlement/reactivate/a25100b8-4e0c-4e37-b921-cac9cb1e930f HTTP/1.1

Reactivate an entitlement. There's no request body.

{
    "responseCode": "OK",
    "responseMessage": "Success",
    "parameters": {},
    "entitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
    "status": "ACTIVE",
    "dateCreated": "2017-08-31T14:15:03Z",
    "dateActivated": "2017-09-16T10:12:67Z",
    "dateEnded": "2017-09-15T09:44:02Z",
    "dateSuspended": null,
    "dateResumed": null,
    "dateLastUpdated": "2017-09-16T10:12:97Z",
    "customerIdentifier": "my-user-123456789",
    "merchantAccountKey": "BANGO_ENTERTAINMENT",
    "productKey": "MUSIC_30D",
    "activationCode": "",
    "entitlementDisplayName": "30 days of Bango Music",
    "offerKey": null,
    "dateExpiry": "2017-09-30T23:59:59.999Z",
    "notificationUrl": "https://example.com/entitlement/notification",
    "extensionData": {
        "price": "9.99",
        "currencyIso3": "GBP",
        "channelType": "WEB_PROMOTION",
        "channelSource": "https://bango.com/promo",
        "campaignKey": "SUMMER_PROMO",
        "referrer": "SEARCH_ENGINE",
        "cancelReasonCode": "NOT_RENEWED",
        "cancelReasonDescription": "The user has not renewed their subscription",
        "renewalDiscount": "10%"
    }
}

The Bango Platform successfully reactivated a canceled entitlement. The cancellation data remains in the extensionData object.

{
    "responseCode": "CLIENT_ACTION_REQUIRED",
    "responseMessage": "An action is required in the client",
    "parameters": {
        "action": "NAVIGATE_TO_URL",
        "url": "https://example.com/?entitlementId=a25100b8-4e0c-4e37-b921-cac9cb1e930f"
    },
    "entitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
    "status": "PENDING",
    "dateCreated": "2017-08-31T14:15:03Z",
    "dateActivated": "2017-09-16T10:12:67Z",
    "dateEnded": "2017-09-15T09:44:02Z",
    "dateSuspended": null,
    "dateResumed": null,
    "dateLastUpdated": "2017-09-16T10:12:97Z",
    "customerIdentifier": "my-user-123456789",
    "merchantAccountKey": "BANGO_ENTERTAINMENT",
    "productKey": "MUSIC_60D",
    "activationCode": "",
    "entitlementDisplayName": "60 days of Bango Music",
    "offerKey": null,
    "dateExpiry": "2017-09-30T23:59:59.999Z",
    "extensionData": {
        "price": "9.99",
        "currencyIso3": "GBP",
        "channelType": "WEB_PROMOTION",
        "channelSource": "https://bango.com/promo",
        "campaignKey": "SUMMER_PROMO",
        "referrer": "SEARCH_ENGINE"
    }
}

The merchant requires the user to complete a process before reactivation, so the Bango Platform returned response code CLIENT_ACTION_REQUIRED with parameters.action value NAVIGATE_TO_URL, and set the entitlement status to PENDING. Your code should ensure the user visits parameters.url, perhaps by programmatically opening that URL on their device.

Entitlements with status PENDING may change status to REVOKED if the user does not complete the merchant process quickly enough. When the user completes the process, the status may change to ACTIVE. The Bango Platform POSTs these status changes to the entitlement's notificationUrl.

{
    "responseCode": "BAD_REQUEST",
    "responseMessage": "Invalid request."
}

The Bango Platform was unable to process the request. This indicates an implementation problem in your code.

{
    "responseCode": "UNAUTHORIZED",
    "responseMessage": "Invalid access credentials."
}

The Bango Platform didn't process the request as the supplied credentials were invalid, or the request was not from an authorized IP address. This indicates an implementation problem in your code or a configuration issue. See Bango Platform / Connectivity and security / Basic authentication and Bango Platform / Connectivity and security / IP whitelisting.

{
    "responseCode": "NOT_AVAILABLE",
    "responseMessage": "No active entitlement routes found."
}

The Bango Platform didn't reactivate the entitlement as the service described in the request is either not enabled for you to use, or has been temporarily disabled due to service issues. Contact Bango Support for more information.

{
    "responseCode": "NOT_FOUND",
    "responseMessage": "Entitlement not found."
}

The Bango Platform didn't find an entitlement record with the specified ID.

{
    "responseCode": "ALREADY_EXISTS",
    "responseMessage": "Entitlement is already active."
}

The Bango Platform didn't reactivate the entitlement as it's already active.

{
    "responseCode": "TOO_MANY_REQUESTS",
    "responseMessage": "Request limit reached. Please try again later"
}

The Bango Platform didn't process the request as you've sent too many requests recently. Try again later.

{
    "responseCode": "INTERNAL_ERROR",
    "responseMessage": "The server encountered an unexpected condition."
}

The Bango Platform couldn't respond to the request. Try again later.

{
    "responseCode": "SERVICE_UNAVAILABLE",
    "responseMessage": "The server is undergoing maintenance."
}

The Bango Platform is undergoing maintenance and is not currently available. Try again later.