Contents

WinBackOfferCreateRequest.Data.Attributes

Attributes that describe a winback offer resource.

Declaration

object WinBackOfferCreateRequest.Data.Attributes

Properties

NameTypeDescription
customerEligibilityPaidSubscriptionDurationInMonths Requiredinteger

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).

customerEligibilityTimeSinceLastSubscribedInMonths RequiredIntegerRange

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.

duration RequiredSubscriptionOfferDuration

The length of time for the offer period.

endDatedate

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

offerId Requiredstring

(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.

offerMode RequiredSubscriptionOfferMode

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

periodCount Requiredinteger

(Required) The number of subscription duration intervals.

priority Requiredstring

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.

referenceName Requiredstring

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.

startDate Requireddate

First available date is today + 1 day.

targetSubscriptionPlanTypeSubscriptionPlanType

The subscription plan type that this offer applies to.

Mentioned in

See Also

Objects