Get a single offer by ID

GET 
/v1/organizations/:organizationId/projects/:projectId/platforms/android/subscriptions/:productId/base-plans/:basePlanId/offers/:offerId

Get a single offer by ID

Request

Path Parameters

organizationId stringrequired
projectId stringrequired
productId stringrequired
basePlanId stringrequired
offerId stringrequired

Query Parameters

includePhases stringrequired

Responses

200

Successfully retrieved offer.

application/json

Schema

Schema

id stringrequired

The unique identifier for the offer.

name stringrequired

The unique name identifier for the offer.

duration stringrequired

Possible values: Value must match regular expression /^P(\d+[YMWD])+$/

The duration of the offer.

eligibility stringrequired

Possible values: [new_customer_acquisition, upgrade, developer_determined]

The eligibility criteria for the offer.

tags string[]required

Tags associated with the offer.

phases object[]
The phases associated with the offer.
Array [
id stringrequired
The unique identifier for the phase.
type PhaseTyperequired
Possible values: [introductory_price, regular, trial, free_trial, discounted_recurring_payment, single_payment]
The type of the phase.
duration stringrequired
Duration of the phase
priceOverride stringrequired
Possible values: [fixed_amount, percentage_discount, absolute_discount]
Override type for the phase price
billingPeriods numberrequired
Number of billing periods for which the override applies
prices object[]
Prices and availability for different countries
Array [
country stringrequired
The country code
priceAmountMicros int64required
The price
]
]
active booleanrequired

Indicates if the offer is active.

createdAt date-timerequired

The creation date of the base plan

updatedAt date-timerequired

The last update date of the base plan

Example (from schema)

{
  "id": "abc123",
  "name": "abc123",
  "duration": "30 days",
  "eligibility": "new_customer_acquisition",
  "tags": [
    "tag1",
    "tag2"
  ],
  "phases": [
    {
      "id": "abc123",
      "type": "free_trial",
      "duration": "P7D",
      "priceOverride": "fixed_amount",
      "billingPeriods": 3,
      "prices": [
        {
          "country": "US",
          "priceAmountMicros": 19990000,
          "currency": "USD"
        }
      ]
    }
  ],
  "active": true,
  "createdAt": "2022-01-01",
  "updatedAt": "2022-01-02"
}

404

Offer not found or error occurred while fetching offer.

Loading...