Parsequerade / docs
Win-back offers
GET/win-back-offers/{winBackOfferId}

Proposed · Extended read design · Adapter not implemented

Request

Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.

cURL
BASE='https://asc.example.com/v1/connections/conn_example'

curl --fail-with-body "$BASE/win-back-offers/win_back_offer_123" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

NameTypeDescription
winBackOfferIdRequiredstringThe selected resource’s ID.

Query parameters

NameTypeDescription
fieldsOptionalstringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.
ValuesreferenceName, offerId, duration, offerMode, periodCount, customerEligibilityPaidSubscriptionDurationInMonths, customerEligibilityTimeSinceLastSubscribedInMonths, customerEligibilityWaitBetweenOffersInMonths, startDate, endDate, priority, promotionIntent, targetSubscriptionPlanType

Response

One flat object for the selected resource.

200 · application/json
{
  "id": "win_back_offer_123",
  "referenceName": "Example subscription",
  "offerId": "offer_123",
  "duration": "THREE_DAYS",
  "offerMode": "PAY_AS_YOU_GO",
  "periodCount": 1
}

Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.

Response fields

NameTypeDescription
idstringApple’s resource ID. Keep this string unchanged when addressing a resource.
referenceNamestringThe internal reference name configured for this resource.
offerIdstringThe ID of the selected offer.
durationstringThe duration value reported by Apple for this resource.
ValuesTHREE_DAYS, ONE_WEEK, TWO_WEEKS, ONE_MONTH, TWO_MONTHS, THREE_MONTHS, SIX_MONTHS, ONE_YEAR
offerModestringThe offer mode value reported by Apple for this resource.
ValuesPAY_AS_YOU_GO, PAY_UP_FRONT, FREE_TRIAL
periodCountintegerThe period count value reported by Apple for this resource.
customerEligibilityPaidSubscriptionDurationInMonthsintegerThe customer eligibility paid subscription duration in months value reported by Apple for this resource.
customerEligibilityTimeSinceLastSubscribedInMonthsobjectThe customer eligibility time since last subscribed in months value reported by Apple for this resource.
customerEligibilityWaitBetweenOffersInMonthsintegerThe customer eligibility wait between offers in months value reported by Apple for this resource.
startDatestring · dateThe beginning of this resource’s scheduled period.
endDatestring · dateThe end of this resource’s scheduled period.
prioritystringThe priority value reported by Apple for this resource.
ValuesHIGH, NORMAL
promotionIntentstringThe promotion intent value reported by Apple for this resource.
ValuesNOT_PROMOTED, USE_AUTO_GENERATED_ASSETS
targetSubscriptionPlanTypestringThe target subscription plan type value reported by Apple for this resource.
ValuesMONTHLY, UPFRONT
customerEligibilityTimeSinceLastSubscribedInMonths fields
NameTypeDescription
minimumOptionalintegerThe minimum value reported by Apple for this resource.
maximumOptionalintegerThe maximum value reported by Apple for this resource.

Behavior

  • A nested resource must belong to the selected parent and the configured connection. The adapter validates ownership before returning data.

Errors

HTTPTypeDescription
400invalid_queryUnsupported filter, sort, limit, or cursor.
401unauthorizedMissing or invalid facade API key.
403forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource.
404resource_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope.
429rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned.
502–504upstream errorApple authentication, response parsing, availability, or timeout failure; this is not an empty result.

Apple mapping

Upstream route and translation

The adapter calls GET /v1/winBackOffers/{id}. Read Apple’s original endpoint ↗

Flatten Apple’s attributes into each resource object. Expose supplied singleton linkage as IDs, with no automatic relationship traversal. Read access does not make these fields writable.

Facade parameterTypeDescription
fieldsqueryfields[winBackOffers]

Reviewed 2026-10-14 · OpenAPI 4.5.1