Method: offers.fetchEligibility

  • The fetchEligibility method retrieves an offer with eligibility based on the provided offerType and optional device identifiers (imei or eid).

  • The request requires an empty body and uses query parameters for specifying the offer type and device information.

  • The response body contains an OfferEligibility object, detailing the offer type, whether the device is eligible, and the offer terms.

  • The OfferTerm includes details such as redemption start and end times, offer duration, monthly data allowance, throttle speed, and eligibility conditions based on IMEI prefixes.

  • Authorization for this method requires either the https://www.googleapis.com/auth/nova or https://www.googleapis.com/auth/cloud-platform OAuth scopes.

Retrieves an offer with eligibility.

HTTP request

GET https://fiwholesaleadaptor.googleapis.com/v1/offers:fetchEligibility

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
offerType

enum (OfferType)

Required. The id of the offer to return with the device eligibility. If there is no matching offer found, a not found error will be returned.
imei

string

Optional. The device identifier used to validate offer eligibility.
eid

string

Optional. The EID of the eSIM on the device used to validate offer eligibility.

Request body

The request body must be empty.

Response body

Response for OfferService.FetchOfferEligibility.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "offer": {
    object (OfferEligibility)
  }
}
Fields
offer

object (OfferEligibility)

The offer for the offerType with eligibility for the device. If there is no matching offer found, a not found error will be returned.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/nova
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the OAuth 2.0 Overview.

OfferEligibility

The offer with eligibility.

JSON representation 
{
  "offerType": enum (OfferType),
  "isEligible": boolean,
  "offerTerm": {
    object (OfferTerm)
  }
}
Fields
offerType

enum (OfferType)

The type of offer.
isEligible

boolean

Whether the device is eligible for the offer.
offerTerm

object (OfferTerm)

The terms for the offer.

OfferTerm

The terms of an offer.

JSON representation 
{
  "eligibleToRedeemStartTime": string,
  "eligibleToRedeemEndTime": string,
  "offerDuration": string,
  "monthlyDataAllowanceBytes": string,
  "monthlyThrottleSpeedBps": string,
  "eligibilityConditions": {
    object (EligibilityConditions)
  }
}
Fields
eligibleToRedeemStartTime

string (Timestamp format)

The start and end time when the offer is eligible to be redeemed.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
eligibleToRedeemEndTime

string (Timestamp format)

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
offerDuration

string (Duration format)

How long a user can use the offer.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
monthlyDataAllowanceBytes

string (int64 format)

The montly data allowance for the offer after which the device will be throttled.
monthlyThrottleSpeedBps

string (int64 format)

After the monthly data allowance is exhausted, the speed of the data connection.
eligibilityConditions

object (EligibilityConditions)

The conditions for a device to be eligible for this offer.

EligibilityConditions

The conditions that must be met for a device to be eligible for this offer. All populated conditions must be met for a device to be eligible.

JSON representation 
{
  "eligibleImeiPrefixes": [
    string
  ]
}
Fields
eligibleImeiPrefixes[]

string

The eligible IMEI prefixes (TAC ranges) for the offer. If empty, all IMEIs are eligible.