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

    Type Alias SubscriptionInput

    type SubscriptionInput = {
        additionalMetaData?: InputMaybe<Scalars["JSON"]>;
        addons?: InputMaybe<SubscriptionAddonInput[]>;
        appliedCoupon?: InputMaybe<SubscriptionCouponInput>;
        awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>;
        billableFeatures?: InputMaybe<BillableFeatureInput[]>;
        billingCountryCode?: InputMaybe<Scalars["String"]>;
        billingId?: InputMaybe<Scalars["String"]>;
        billingInformation?: InputMaybe<SubscriptionBillingInfo>;
        billingPeriod?: InputMaybe<BillingPeriod>;
        budget?: InputMaybe<BudgetConfigurationInput>;
        charges?: InputMaybe<ChargeInput[]>;
        crmId?: InputMaybe<Scalars["String"]>;
        customerId: Scalars["String"];
        endDate?: InputMaybe<Scalars["DateTime"]>;
        entitlements?: InputMaybe<SubscriptionEntitlementInputV2[]>;
        environmentId?: InputMaybe<Scalars["UUID"]>;
        isCustomPriceSubscription?: InputMaybe<Scalars["Boolean"]>;
        isOverridingTrialConfig?: InputMaybe<Scalars["Boolean"]>;
        isTrial?: InputMaybe<Scalars["Boolean"]>;
        minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>;
        payingCustomerId?: InputMaybe<Scalars["String"]>;
        paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>;
        planId: Scalars["String"];
        priceOverrides?: InputMaybe<PriceOverrideInput[]>;
        priceUnitAmount?: InputMaybe<Scalars["Float"]>;
        promotionCode?: InputMaybe<Scalars["String"]>;
        refId?: InputMaybe<Scalars["String"]>;
        resourceId?: InputMaybe<Scalars["String"]>;
        salesforceId?: InputMaybe<Scalars["String"]>;
        scheduleStrategy?: InputMaybe<ScheduleStrategy>;
        startDate?: InputMaybe<Scalars["DateTime"]>;
        subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>;
        subscriptionId?: InputMaybe<Scalars["String"]>;
        trialEndBehavior?: InputMaybe<TrialEndBehavior>;
        unitQuantity?: InputMaybe<Scalars["Float"]>;
    }
    Index

    Properties

    additionalMetaData?: InputMaybe<Scalars["JSON"]>
    addons?: InputMaybe<SubscriptionAddonInput[]>
    appliedCoupon?: InputMaybe<SubscriptionCouponInput>

    Coupon input

    awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>
    billableFeatures?: InputMaybe<BillableFeatureInput[]>
    billingCountryCode?: InputMaybe<Scalars["String"]>
    billingId?: InputMaybe<Scalars["String"]>
    billingInformation?: InputMaybe<SubscriptionBillingInfo>
    billingPeriod?: InputMaybe<BillingPeriod>
    budget?: InputMaybe<BudgetConfigurationInput>

    Budget configuration

    charges?: InputMaybe<ChargeInput[]>
    crmId?: InputMaybe<Scalars["String"]>
    customerId: Scalars["String"]
    endDate?: InputMaybe<Scalars["DateTime"]>
    entitlements?: InputMaybe<SubscriptionEntitlementInputV2[]>
    environmentId?: InputMaybe<Scalars["UUID"]>
    isCustomPriceSubscription?: InputMaybe<Scalars["Boolean"]>
    isOverridingTrialConfig?: InputMaybe<Scalars["Boolean"]>
    isTrial?: InputMaybe<Scalars["Boolean"]>
    minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>

    The minimum spend configuration

    payingCustomerId?: InputMaybe<Scalars["String"]>
    paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>

    Subscription payment collection method

    planId: Scalars["String"]
    priceOverrides?: InputMaybe<PriceOverrideInput[]>

    Override the price of the subscription

    priceUnitAmount?: InputMaybe<Scalars["Float"]>
    promotionCode?: InputMaybe<Scalars["String"]>
    refId?: InputMaybe<Scalars["String"]>
    resourceId?: InputMaybe<Scalars["String"]>
    salesforceId?: InputMaybe<Scalars["String"]>
    scheduleStrategy?: InputMaybe<ScheduleStrategy>
    startDate?: InputMaybe<Scalars["DateTime"]>
    subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>
    subscriptionId?: InputMaybe<Scalars["String"]>
    trialEndBehavior?: InputMaybe<TrialEndBehavior>

    Indicates the behavior of the subscription when the trial is expired.

    unitQuantity?: InputMaybe<Scalars["Float"]>

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR