Skip to main content
In the Bango Platform, entitlements describe a user’s ability to access a service provided by a merchant. To make changes to an existing entitlement, you send a PATCH request to the Bango Resale API. You can’t cancel, or revoke entitlements using PATCH requests: a PATCH can’t change the status property to CANCELLED or REVOKED. Use the more specific cancel or revoke API requests instead. As part of the API request, you supply: You can suspend, or resume entitlements using PATCH requests. For more information see suspend or resume. You can reverse a cancellation before the dateEnded is reached using PATCH requests. For more information see cancel. The API response is a structure that contains:
  • A response code, indicating the result of the request. Use this code to determine what to do next.
  • For HTTP 2xx responses, the entitlement record.
Depending on merchant requirements and potentially other factors, the response code might indicate that your code needs to take some action as a result of the update request. For example, the update might require the user to visit a web page to perform a process. In this case the entitlement record returned contains your requested updates but with status PENDING, and any later change to status ACTIVE is POSTed to the entitlement’s notificationUrl, if specified.

Sequence diagrams

The Bango Platform updates the entitlement and the user does not have to perform a process. The entitlement status does not change.
Image
The merchant requires the user to perform a process. The Bango Platform returns an updated entitlement with status PENDING, with the response code CLIENT_ACTION_REQUIRED and action NAVIGATE_TO_URL, together with the target URL. You send the user to the URL, and when the user completes the process the Bango Platform notifies you by direct server-to-server communication.
Image
The Bango Platform can’t update the entitlement, and returns the reason in the response to the API request.
Image

Skeleton code

Here’s some sample code in a C/Java-like language: adapt this code to your needs. Use the same API endpoint prefix with test credentials and with production credentials. Some functions referenced in the skeleton code, such as redirect_device_to, are not defined. You need to implement these where possible.

FAQ

You must set the entitlementId. Include any other parameters you want to update: any parameter not included in the request is not changed.See Bango Resale / For resellers / Reseller API reference / Reseller API reference overview for detailed information on all request parameters.
It depends on the merchant, the user, the service, and possibly other factors. In most cases you won’t have to do anything: the update request will return the response code OK.One likely reason for the response code CLIENT_ACTION_REQUIRED may be a change in productKey: perhaps you’re upgrading the user to a new service tier, and the merchant requires an additional setup process.
All responses contain a responseCode string that indicates the result of the request. Use this code to determine how to react. For each distinct responseCode, the response might include other useful values.See Bango Resale / For resellers / Reseller API reference / Reseller API reference overview for detailed information on all responses.