Parsequerade / docs
Subscription Promotional Offers
GET/subscription-promotional-offers/{subscriptionPromotionalOfferId}

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/subscription-promotional-offers/subscription_promotional_offer_123" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

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

Path parameters

NameTypeDescription
subscriptionPromotionalOfferIdRequiredstringThe 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.
Valuesduration, name, numberOfPeriods, offerCode, offerMode, targetSubscriptionPlanType

Response

One flat object for the selected resource.

200 · application/json
{
  "id": "subscription_promotional_offer_123",
  "duration": "THREE_DAYS",
  "name": "Example Notes",
  "numberOfPeriods": 1,
  "offerCode": "offer_code_example",
  "offerMode": "PAY_AS_YOU_GO"
}

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.
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
namestringThe resource’s name. An app’s localized name is read from its app-info localization.
numberOfPeriodsintegerThe number of periods value reported by Apple for this resource.
offerCodestringThe offer code value reported by Apple for this resource.
offerModestringThe offer mode value reported by Apple for this resource.
ValuesPAY_AS_YOU_GO, PAY_UP_FRONT, FREE_TRIAL
targetSubscriptionPlanTypestringThe target subscription plan type value reported by Apple for this resource.
ValuesMONTHLY, UPFRONT
subscriptionIdOptional linkagestring | nullID of the related subscription. Present only when Apple supplies linkage; related objects are not loaded automatically.

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/subscriptionPromotionalOffers/{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[subscriptionPromotionalOffers]

Reviewed 2026-10-14 · OpenAPI 4.5.1