Lens Scripting API
    Preparing search index...

    Class PricingPhase

    Describes one phase of a subscription offer's pricing schedule, such as a free trial, an introductory price, or the regular recurring price. Phases apply in the order they are provided.

    Lens Scripting Version 377

    function printPricingPhases(offer: Commerce.SubscriptionOfferDetails) {
      offer.pricingPhases.forEach((phase: Commerce.PricingPhase) => {
        print(`${phase.billingPeriod}: ${phase.price.displayPrice}`);
      });
    }

    Hierarchy (View Summary)

    Index

    Properties

    billingCycleCount billingPeriod price recurrenceMode

    Methods

    getTypeName getTypeName isOfType isSame

    Properties

    billingCycleCount: number

    The number of billing cycles this phase lasts for RecurrenceMode.FiniteRecurring phases.

    Lens Scripting Version 377

    billingPeriod: string

    The billing period of this phase as an ISO 8601 duration string, such as "P1W" (weekly), "P1M" (monthly), "P3M" (quarterly), or "P1Y" (yearly).

    Lens Scripting Version 377

    price: Price

    The price charged for this phase, provided as a Price object.

    Lens Scripting Version 377

    recurrenceMode: RecurrenceMode

    Describes whether this phase repeats indefinitely, repeats a fixed number of times, or is charged once.

    Lens Scripting Version 377

    Methods

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Returns string

      Lens Scripting Version 377

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods