Get an offer - Bango product documentation

Get an offer

curl --request GET \
  --url https://api.sandbox.bango.com/catalogs/offers/{offerId} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.sandbox.bango.com/catalogs/offers/{offerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.bango.com/catalogs/offers/{offerId}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "offerId": "f58ecec5-27cc-40c8-8723-4d01678fed6f",
  "name": "Bango Music Premium - 1 month free",
  "availableFromTs": "2024-06-22T17:35:38.922Z",
  "availableToTs": "2025-06-22T17:35:38.922Z",
  "products": [
    {
      "productId": "5f721731-2946-45f9-9f0e-03df00cf11ed",
      "name": "Music",
      "productTier": {
        "productTierId": "4020dd8a-99fd-441e-b14b-575166c9b43b",
        "name": "Premium",
        "productTierKey": "PREMIUM_1_MONTH_FREE"
      },
      "contentProvider": {
        "contentProviderId": "fc5c87fb-469c-4623-8277-cfa9c13d63bc",
        "name": "Bango",
        "merchantAccountKey": "BANGO"
      }
    }
  ],
  "plan": {
    "planId": "1eb68c4e-52a1-423a-8742-0396e97c0fb7",
    "lifecycleStartTrigger": {
      "triggerSource": "CONSUMER_OFFER",
      "triggerEvent": "CONSUMER_OFFER_FULLY_CREATED"
    },
    "type": "SUBSCRIPTION",
    "currency": "USD",
    "currencyAssetScale": 2,
    "phases": [
      {
        "sequence": 0,
        "priceType": "FREE",
        "renewalFrequency": "P1M",
        "duration": "P1M",
        "amount": 0,
        "displayAmount": "0.00",
        "billingDescription": "Bango Music Premium Free"
      },
      {
        "sequence": 1,
        "priceType": "FULL_PRICE",
        "renewalFrequency": "P1M",
        "amount": 1099,
        "displayAmount": "10.99",
        "billingDescription": "Bango Music Premium"
      }
    ]
  }
}

GET

/

catalogs

/

offers

/

{offerId}

Get an offer

curl --request GET \
  --url https://api.sandbox.bango.com/catalogs/offers/{offerId} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.sandbox.bango.com/catalogs/offers/{offerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.bango.com/catalogs/offers/{offerId}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "offerId": "f58ecec5-27cc-40c8-8723-4d01678fed6f",
  "name": "Bango Music Premium - 1 month free",
  "availableFromTs": "2024-06-22T17:35:38.922Z",
  "availableToTs": "2025-06-22T17:35:38.922Z",
  "products": [
    {
      "productId": "5f721731-2946-45f9-9f0e-03df00cf11ed",
      "name": "Music",
      "productTier": {
        "productTierId": "4020dd8a-99fd-441e-b14b-575166c9b43b",
        "name": "Premium",
        "productTierKey": "PREMIUM_1_MONTH_FREE"
      },
      "contentProvider": {
        "contentProviderId": "fc5c87fb-469c-4623-8277-cfa9c13d63bc",
        "name": "Bango",
        "merchantAccountKey": "BANGO"
      }
    }
  ],
  "plan": {
    "planId": "1eb68c4e-52a1-423a-8742-0396e97c0fb7",
    "lifecycleStartTrigger": {
      "triggerSource": "CONSUMER_OFFER",
      "triggerEvent": "CONSUMER_OFFER_FULLY_CREATED"
    },
    "type": "SUBSCRIPTION",
    "currency": "USD",
    "currencyAssetScale": 2,
    "phases": [
      {
        "sequence": 0,
        "priceType": "FREE",
        "renewalFrequency": "P1M",
        "duration": "P1M",
        "amount": 0,
        "displayAmount": "0.00",
        "billingDescription": "Bango Music Premium Free"
      },
      {
        "sequence": 1,
        "priceType": "FULL_PRICE",
        "renewalFrequency": "P1M",
        "amount": 1099,
        "displayAmount": "10.99",
        "billingDescription": "Bango Music Premium"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Basic authentication

Path Parameters

offerId

string<uuid>

required

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.

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

Show child attributes

localizedData

object

Show child attributes

plan

object

Show child attributes