Class

StoreProductDiscount

Type that wraps StoreKit.Product.SubscriptionOffer and SKProductDiscount and provides access to their properties. Information about a subscription offer that you configured in App Store Connect.

Declaration

@objc(RCStoreProductDiscount) final class StoreProductDiscount

Topics

Structures

struct Data
Used to represent StoreProductDiscount/id. Not for public use.

Instance Properties

var currencyCode: String?
The currency of the product’s price.
var hash: Int
var localizedPriceString: String
The price of this product discount formatted for locale.
var offerIdentifier: String?
A string used to uniquely identify a discount offer for a product.
var paymentMode: StoreProductDiscount.PaymentMode
The payment mode for this product discount.
var price: Decimal
The discount price of the product in the local currency.
var priceDecimalNumber: NSDecimalNumber
The discount price of the product in the local currency.
var sk1Discount: SK1ProductDiscount?
Returns the SK1ProductDiscount if this StoreProductDiscount represents a SKProductDiscount.
var sk2Discount: SK2ProductDiscount?
Returns the SK2ProductDiscount if this StoreProductDiscount represents a Product.SubscriptionOffer.
var subscriptionPeriod: SubscriptionPeriod
The period for the product discount.
var type: StoreProductDiscount.DiscountType
The type of product discount.

Instance Methods

func isEqual(Any?) -> Bool

Enumerations

enum DiscountType
The discount type for a StoreProductDiscount Wraps SKProductDiscount.Type if this StoreProductDiscount represents a SKProductDiscount. Wraps Product.SubscriptionOffer.OfferType if this StoreProductDiscount represents a Product.SubscriptionOffer.
enum PaymentMode
The payment mode for a StoreProductDiscount Indicates how the product discount price is charged.

Default Implementations

Identifiable Implementations
Encodable Implementations

Relationships

Inherits From

    Conforms To

    • ObjectiveC.NSObjectProtocol
    • Swift.CVarArg
    • Swift.CustomDebugStringConvertible
    • Swift.CustomStringConvertible
    • Swift.Encodable
    • Swift.Equatable
    • Swift.Hashable
    • Swift.Identifiable

    See Also

    Making Purchases with Subscription Offers

    class IntroEligibility
    Holds the introductory price status
    class PromotionalOffer
    Represents a StoreProductDiscount that has been validated and is ready to be used for a purchase.
    func checkTrialOrIntroDiscountEligibility(productIdentifiers: [String]) async -> [String : IntroEligibility]
    Computes whether or not a user is eligible for the introductory pricing period of a given product. You should use this method to determine whether or not you show the user the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing). iOS Introductory Offers.
    func checkTrialOrIntroDiscountEligibility(productIdentifiers: [String], completion: ([String : IntroEligibility]) -> Void)
    Computes whether or not a user is eligible for the introductory pricing period of a given product. You should use this method to determine whether or not you show the user the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing). iOS Introductory Offers.
    func checkTrialOrIntroDiscountEligibility(product: StoreProduct) async -> IntroEligibilityStatus
    Computes whether or not a user is eligible for the introductory pricing period of a given product. You should use this method to determine whether or not you show the user the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing). iOS Introductory Offers.
    func checkTrialOrIntroDiscountEligibility(product: StoreProduct, completion: (IntroEligibilityStatus) -> Void)
    Computes whether or not a user is eligible for the introductory pricing period of a given product. You should use this method to determine whether or not you show the user the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing). iOS Introductory Offers.
    func getPromotionalOffer(forProductDiscount: StoreProductDiscount, product: StoreProduct) async throws -> PromotionalOffer
    Use this method to find eligibility for this user for iOS Promotional Offers.
    func getPromotionalOffer(forProductDiscount: StoreProductDiscount, product: StoreProduct, completion: (PromotionalOffer?, Error?) -> Void)
    Use this method to fetch PromotionalOffer to use in purchase(package:promotionalOffer:) or purchase(product:promotionalOffer:). iOS Promotional Offers.
    func purchase(package: Package, promotionalOffer: PromotionalOffer) async throws -> PurchaseResultData
    Purchase the passed Package. Call this method when a user has decided to purchase a product with an applied discount. Only call this in direct response to user input. From here Purchases will handle the purchase with StoreKit and call the PurchaseCompletedBlock.
    func purchase(package: Package, promotionalOffer: PromotionalOffer, completion: PurchaseCompletedBlock)
    Purchase the passed Package. Call this method when a user has decided to purchase a product with an applied discount. Only call this in direct response to user input. From here Purchases will handle the purchase with StoreKit and call the PurchaseCompletedBlock.
    func purchase(product: StoreProduct, promotionalOffer: PromotionalOffer) async throws -> PurchaseResultData
    Use this function if you are not using the Offerings system to purchase a StoreProduct with an applied PromotionalOffer. If you are using the Offerings system, use purchase(package:promotionalOffer:completion:) instead.
    func purchase(product: StoreProduct, promotionalOffer: PromotionalOffer, completion: PurchaseCompletedBlock)
    Initiates a purchase of a StoreProduct with a PromotionalOffer.