Contents

WinBackOffer.Attributes

Attributes that describe a winback offer resource.

Declaration

object WinBackOffer.Attributes

Properties

NameTypeDescription
customerEligibilityPaidSubscriptionDurationInMonthsinteger

How long a customer was a subscriber. Possible values are 1 to 24 (months as integers), 36 (3 years), 48 (4 years), and 60 (5 years).

customerEligibilityTimeSinceLastSubscribedInMonthsIntegerRange

How long since the subscriber last had an active subscription.

customerEligibilityWaitBetweenOffersInMonthsinteger

The minimum time between the end of the customer’s subscription and the customer redeeming the same offer again. Optional. Possible values are 2 to 24 months.

durationSubscriptionOfferDuration

The length of time for the offer period.

endDatedate

Minimum length for a win-back offer is 3 days.

offerIdstring

(Required) string of alphanumeric characters, periods, and underscores, up to 100 characters. Use a unique value that you have not used for a promotional offer, offer code, or introductory offer, when you create your win-back offer.

offerModeSubscriptionOfferMode

(Required) Describes how payment is configured for a win-back offer.

periodCountinteger

(Required) The number of subscription duration intervals.

prioritystring

Select how this offer ranks among your other offers and in-app events. HIGH priority offers will appear above other offers and events on your appʼs product page.

promotionIntentstring

You can promote this offer on your App Store product page. Promoted offers can also display in search results and may be featured on the Today, Games, and Apps tabs. If your win-back offer is live and promotionIntent is set to USE_AUTO_GENERATED_ASSETS you need to delete the win-back offer in order to remove it from promotion.

referenceNamestring

A string of alphanumeric characters, spaces, periods, and underscores, up to 65 characters. Use a unique value that you have not used for a promotional offer, offer code, or introductory offer, when you create your win-back offer.

startDatedate

First available date is today + 1 day.

targetSubscriptionPlanTypeSubscriptionPlanType

The subscription plan type that this offer applies to.

See Also

Objects