Get a single phase by ID

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

Get a single phase by ID

Request

Path Parameters

organizationId stringrequired
projectId stringrequired
productId stringrequired
basePlanId stringrequired
offerId stringrequired
phaseId stringrequired

Query Parameters

includePrices stringrequired

Responses

200

Successfully retrieved phase.

application/json

Schema

Schema

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
]

Example (from schema)

{
  "id": "abc123",
  "type": "free_trial",
  "duration": "P7D",
  "priceOverride": "fixed_amount",
  "billingPeriods": 3,
  "prices": [
    {
      "country": "US",
      "priceAmountMicros": 19990000,
      "currency": "USD"
    }
  ]
}

404

Phase not found or error occurred while fetching phase.

Loading...