journeyState

Returns the current state of a customer's subscription journey.

Swift

static func journeyState() -> CustomerJourneyState?

Kotlin

fun journeyState(): CustomerJourneyState?

Flutter

static Future<CustomerJourneyState?> journeyState() async

React Native

export type CustomerJourneyState = {
  formerSubscriber: boolean;
  inGracePeriod: boolean;
  inTrialPeriod: boolean;
  inIntroOfferPeriod: boolean;
  isCancelled: boolean;
  inPause: boolean;
  inAccountHold: boolean;
};

Unity

public class CustomerJourneyState
{
    public bool FormerSubscriber { get; private set; }

    public bool InGracePeriod { get; private set; }

    public bool InTrialPeriod { get; private set; }

    public bool InIntroOfferPeriod { get; private set; }

    public bool IsCancelled { get; private set; }

    /// <summary> Android platforms only </summary>
    public bool InPause { get; private set; }

    public bool InAccountHold { get; private set; }
}

Returns a CustomerJourneyState object.