One Logo Pool Ball
StoreKit · IOS API REFERENCE

Transaction.Offer

struct · iOS 17.2+ · SDK 27.1

struct Offer

Details for the offer applied to this transaction.

Members (4)

get · iOS 17.2+

paymentMode

TypeScript
get paymentMode(): (Transaction_Offer_PaymentMode) | null
Swift declaration
let paymentMode: Transaction.Offer.PaymentMode?

The payment mode of the offer applied to a transaction. - Note: The payment mode may be unknown for transactions created before the release of App Store Server API 1.10. If the payment mode is unknown, the property is nil.

get · iOS 17.2+

id

TypeScript
get id(): (string) | null
Swift declaration
let id: String?

Identifies the offer applied to this transaction for `promotional` and `code` offer types. If `offerType` is `promotional`, this will be the offer identifier. If `offerType` is `code`, this will be the offer code reference name. This will be `nil` for `introductory` offers and if there is no offer applied.

get · iOS 17.2+

type

TypeScript
get type(): Transaction_OfferType
Swift declaration
let type: Transaction.OfferType

The type of subscription offer applied to this transaction.

get · iOS 18.4+

period

TypeScript
get period(): (Product_SubscriptionPeriod) | null
Swift declaration
let period: Product.SubscriptionPeriod?

The duration of the offer applied to a transaction.

Skipped declarations

No declarations were skipped in this snapshot.

All StoreKit types →