List the offers of an App

GET

/apps/{appId}/offers

const url = 'https://api.passion.io/v1/apps/example/offers';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.passion.io/v1/apps/example/offers

Parameters

Path Parameters

appId

required

The id of the App, as Studio shows it.

string

/^[1-9][0-9]*$/

Responses

200

application/json

object

offers

required

Array<object>

object

required

string

name

required

string

description

required

Any of:

string
null

string

benefits

required

What the offer gives, in the creator’s words and order.

Array<string>

price

required

object

netCents

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

currency

required

ISO 4217 code, for example USD.

string

recurring

required

True when members pay again every billing period.

boolean

billingPeriod

required

Any of:

string
null

string

Allowed values: OneWeek OneMonth ThreeMonths SixMonths OneYear

trialPeriod

required

Any of:

string
null

string

Allowed values: ThreeDays OneWeek TwoWeeks OneMonth

access

required

Public: every member of the App gets it when they sign in, free. Restricted: members buy it.

string

Allowed values: Public Restricted

availability

required

object

native

required

Sold inside the iOS and Android apps.

boolean

web

required

Listed in the web price list of the App.

boolean

products

required

What the offer gives access to. A course id here is the id the course list answers.

Array<object>

object

required

string

type

required

string

Allowed values: Course Community AiChatBot Tracking CheckIn

Example

{
  "offers": [
    {
      "billingPeriod": "OneWeek",
      "trialPeriod": "ThreeDays",
      "access": "Public",
      "products": [
        {
          "type": "Course"
        }
      ]
    }
  ]
}