Skip to main content
GET
Get offers

Authorizations

Authorization
string
header
required

Basic authentication

Query Parameters

locale
string

Use this parameter to return localizedData translations for the locale provided.

  • If there are no translations for this locale, an empty localizedData resource is included in the response.
  • If locale is not included in the request, the localizedData resource is omitted from the response.
productId
string

Use this parameter to filter the offers returned to only those that are related to the productId specified.

  • If there are no offers associated to that productId the array returned will be empty.

Response

Offers retrieved successfully

offerId
string<uuid>
required

Bango's unique identifier of the offer

Example:

"f58ecec5-27cc-40c8-8723-4d01678fed6f"

name
string
required

The offer name

Example:

"Bango Music Premium - 1 month free"

availableFromTs
string<date-time>
required

The date from which this offer is available to consumers

Example:

"2024-06-22T17:35:38.922Z"

availableToTs
string<date-time>
required

The date after which this offer is no longer available to consumers

Example:

"2024-06-22T17:35:38.922Z"

products
object[]
required
localizedData
object
plan
object