Skip to main content

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

Successfully retrieved offer.

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

Loading...