When a consumer decides to take an offer, the reseller sends a create request to the consumer offer API.

The consumer offer API orchestrates the creation of everything needed under-the-hood based on the configuration of the offer. Requests are sent to create entitlements for each product (tier) associated to the offer. In addition, a billing plan is created for the consumer’s offer to manage its lifecycle. The plan tells us when the lifecycle should start, and the phase change and renewal frequency information needed to drive the lifecycle (e.g. cancelling at the end of the current renewal period, or end of a free phase). It also enables us to send entitlement updates to content providers on behalf of the reseller if the content provider wants to know when the consumer transitions from free to paid.

As an offer can contain multiple content provider products and services, the create consumer offer request to Bango is asynchronous. On receipt of 202 (accepted), send an immediate GET request with the awaitStatus parameter FULLY_CREATED and a timeout (the time you are prepared to wait for a response).

Bango sends the response as soon as the consumer offer status is FULLY_CREATED.

In the unlikely event of a timeout, Bango responds with as much information as possible based on the responses we’ve had so far. This enables you to provide as much activation information as possible back to your consumer as quickly as possible.

You can also use the entitlement API to request refreshed activation information if the consumer doesn’t (or can’t) immediately complete the activation flow.