Interface AdaptyProduct

Describes an object that represents a product. Used in getPaywallProducts method and in makePurchase method.

Hierarchy

  • AdaptyProduct

Properties

android? currencyCode? currencySymbol? introductoryDiscount? introductoryOfferEligibility ios? localizedDescription localizedPrice? localizedSubscriptionPeriod? localizedTitle paywallABTestName paywallName price subscriptionPeriod variationId vendorProductId

Properties

Optional android

android?: {
    freeTrialPeriod?: AdaptySubscriptionPeriod;
    localizedFreeTrialPeriod?: string;
}

Type declaration

Optional Readonly currencyCode

currencyCode?: string

The currency code of the locale used to format the price of the product. The ISO 4217 (USD, EUR).

Optional Readonly currencySymbol

currencySymbol?: string

The currency symbol of the locale used to format the price of the product. ($, €).

Optional Readonly introductoryDiscount

introductoryDiscount?: AdaptyProductDiscount

An object containing introductory price information for a product. iOS: Will be null for iOS version below 11.2 and macOS version below 10.14.4.

Readonly introductoryOfferEligibility

introductoryOfferEligibility: OfferEligibility

User's eligibility for your introductory offer. Check this property before displaying info about introductory offers (i.e. free trials)

Optional ios

ios?: {
    discounts: AdaptyProductDiscount[];
    isFamilyShareable: boolean;
    promotionalOfferEligibility: OfferEligibility;
    promotionalOfferId?: string;
    regionCode?: string;
    subscriptionGroupIdentifier?: string;
}

Type declaration

  • Readonly discounts: AdaptyProductDiscount[]

    An array of subscription offers available for the auto-renewable subscription. Will be empty for iOS version below 12.2 and macOS version below 10.14.4.

  • Readonly isFamilyShareable: boolean

    Boolean value that indicates whether the product is available for family sharing in App Store Connect. Will be false for iOS version below 14.0 and macOS version below 11.0.

    See

    https://developer.apple.com/documentation/storekit/skproduct/3564805-isfamilyshareable

  • Readonly promotionalOfferEligibility: OfferEligibility

    User's eligibility for the promotional offers. Check this property before displaying info about promotional offers

  • Optional Readonly promotionalOfferId?: string

    An identifier of a promotional offer, provided by Adapty for this specific user.

  • Optional Readonly regionCode?: string

    The region code of the locale used to format the price of the product. ISO 3166 ALPHA-2 (US, DE)

  • Optional Readonly subscriptionGroupIdentifier?: string

    An identifier of the subscription group to which the subscription belongs. Will be null for iOS version below 12.0 and macOS version below 10.14.

Readonly localizedDescription

localizedDescription: string

A description of the product.

Optional Readonly localizedPrice

localizedPrice?: string

A price’s language is determined by the preferred language set on the device. On Android, the formatted price from Google Play as is.

Optional Readonly localizedSubscriptionPeriod

localizedSubscriptionPeriod?: string

The period’s language is determined by the preferred language set on the device.

Readonly localizedTitle

localizedTitle: string

The name of the product.

Readonly paywallABTestName

paywallABTestName: string

Same as abTestName property of the parent AdaptyPaywall.

Readonly paywallName

paywallName: string

Same as name property of the parent AdaptyPaywall.

Readonly price

price: number

The cost of the product in the local currency

Readonly subscriptionPeriod

subscriptionPeriod: AdaptySubscriptionPeriod

The period details for products that are subscriptions. Will be null for iOS version below 11.2 and macOS version below 10.14.4.

Readonly variationId

variationId: string

Same as variationId property of the parent AdaptyPaywall.

Readonly vendorProductId

vendorProductId: string

Unique identifier of a product from App Store Connect or Google Play Console

Settings

Member Visibility

Theme

Generated using TypeDoc