@stigg/js-client-sdk - v3.102.0

    Type Alias Subscription

    type Subscription = {
        addons: SubscriptionAddon[];
        billingId?: string;
        cancellationDate?: Date;
        crmId?: string;
        currentBillingPeriodEnd?: Date;
        effectiveEndDate?: Date;
        endDate?: Date;
        experimentInfo?: ExperimentInfo | null;
        futureUpdates: SubscriptionFutureUpdateDataFragment[];
        id: string;
        latestInvoice?: SubscriptionInvoiceFragment;
        metadata?: Metadata | null;
        payingCustomer?: SlimCustomer | null;
        paymentCollection: PaymentCollection;
        paymentCollectionMethod?: PaymentCollectionMethod;
        plan: Plan;
        price: SubscriptionPrice | null;
        prices: Price[];
        pricingType: PricingType;
        resourceId?: string;
        scheduledUpdates?: CustomerPortalSubscriptionScheduledUpdateDataFragment[];
        startDate: Date;
        status: SubscriptionStatus;
        totalPrice: TotalPriceFragment | null | undefined;
        trialEndDate?: Date;
    }
    Index

    Properties

    addons billingId? cancellationDate? crmId? currentBillingPeriodEnd? effectiveEndDate? endDate? experimentInfo? futureUpdates id latestInvoice? metadata? payingCustomer? paymentCollection paymentCollectionMethod? plan price prices pricingType resourceId? scheduledUpdates? startDate status totalPrice trialEndDate?

    Properties

    addons: SubscriptionAddon[]
    billingId?: string
    cancellationDate?: Date
    crmId?: string
    currentBillingPeriodEnd?: Date
    effectiveEndDate?: Date

    The calculated end date after which the subscription will be canceled, which takes trial expiration and scheduled cancellations into consideration

    endDate?: Date
    experimentInfo?: ExperimentInfo | null
    futureUpdates: SubscriptionFutureUpdateDataFragment[]

    Future updates can be of 2 types SubscriptionScheduleStatus.Scheduled or SubscriptionScheduleStatus.PendingPayment

    id: string
    latestInvoice?: SubscriptionInvoiceFragment
    metadata?: Metadata | null
    payingCustomer?: SlimCustomer | null
    paymentCollection: PaymentCollection
    paymentCollectionMethod?: PaymentCollectionMethod
    plan: Plan
    price: SubscriptionPrice | null

    use prices instead with totalPrice

    prices: Price[]
    pricingType: PricingType
    resourceId?: string
    scheduledUpdates?: CustomerPortalSubscriptionScheduledUpdateDataFragment[]

    use futureUpdates instead with filter for SubscriptionScheduleStatus.Scheduled

    startDate: Date
    status: SubscriptionStatus
    totalPrice: TotalPriceFragment | null | undefined
    trialEndDate?: Date

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR