@stigg/node-server-sdk - v4.22.1

    Interface StiggManagementAPI

    interface StiggManagementAPI {
        applySubscription: (
            params: ApplySubscription,
        ) => Promise<ApplySubscriptionResults>;
        archiveCustomer: (customerId: string) => Promise<string>;
        cancelSubscription: (
            cancelSubscription: CancelSubscription,
        ) => Promise<Subscription>;
        cancelSubscriptionScheduledUpdates: (
            cancelSubscriptionScheduledUpdates: CancelSubscriptionScheduledUpdates,
        ) => Promise<{ subscriptionId: string }>;
        createCustomer: (params: CreateCustomer) => Promise<SlimCustomer>;
        createSubscription: (
            createSubscription: CreateSubscription,
        ) => Promise<Subscription>;
        detachCustomerPaymentMethod: (customerId: string) => Promise<SlimCustomer>;
        getCustomer: (customerId: string) => Promise<FullCustomer>;
        importCustomer: (params: ImportCustomer) => Promise<SlimCustomer>;
        importCustomerBulk: (params: ImportCustomerBulk) => Promise<void>;
        importSubscriptionBulk: (params: ImportSubscriptionBulk) => Promise<void>;
        provisionCustomer: (
            params: ProvisionCustomer,
        ) => Promise<ProvisionedCustomer>;
        provisionSubscription: (
            provisionSubscription: ProvisionSubscription,
        ) => Promise<ProvisionSubscriptionResult>;
        unarchiveCustomer: (customerId: string) => Promise<SlimCustomer>;
        updateCustomer: (params: UpdateCustomer) => Promise<SlimCustomer>;
        updateSubscription: (
            updateSubscription: UpdateSubscription,
        ) => Promise<Subscription>;
        delegateSubscriptionToCustomer(
            input: DelegateSubscriptionToCustomerInput,
        ): Promise<Subscription>;
        estimateSubscription(
            estimateSubscription: EstimateSubscription,
        ): Promise<SubscriptionPreview>;
        estimateSubscriptionUpdate(
            estimateSubscriptionUpdate: EstimateSubscriptionUpdate,
        ): Promise<SubscriptionPreview>;
        getActiveSubscriptions(
            params: GetActiveSubscriptions,
        ): Promise<FullSubscription[]>;
        getActiveSubscriptionsList(
            params: GetActiveSubscriptions,
        ): Promise<SlimSubscriptionFragmentV2Fragment[]>;
        getAutomaticRechargeConfiguration(
            input: GetAutoRechargeSettingsInput,
        ): Promise<AutoRechargeSettingsFragment>;
        getCoupons(): Promise<Coupon[]>;
        getCreditBalance(
            input: CreditBalanceSummaryInput,
        ): Promise<CreditsBalanceSummaryFragment>;
        getCreditGrants(
            input: GetCreditGrantsInput,
        ): Promise<GetCreditGrantsResult>;
        getCreditLedger(input: CreditLedgerInput): Promise<GetCreditLedgerResult>;
        getCreditUsage(input: CreditUsageInput): Promise<CreditUsageFragment>;
        getCustomerStatistics(customerId: string): Promise<CustomerStatisticsModel>;
        getPaywall(params?: GetPaywall): Promise<Paywall>;
        getProducts(): Promise<Product[]>;
        getSubscription(params: GetSubscription): Promise<FullSubscription>;
        getSubscriptions(
            params: GetSubscriptionsParams,
        ): Promise<GetSubscriptionsResult>;
        getUsageHistoryV2(
            input: UsageHistoryV2Input,
        ): Promise<UsageHistoryV2Fragment>;
        grantCredits(
            input: CreditGrantInput,
        ): Promise<CreditGrantFragment | undefined>;
        grantPromotionalEntitlements(
            input: GrantPromotionalEntitlementsInput,
        ): Promise<PromotionalEntitlementFragment[]>;
        grantPromotionalEntitlementsGroup(
            input: GrantPromotionalEntitlementsGroupInput,
        ): Promise<PromotionalEntitlementFragment[]>;
        previewNextInvoice(
            previewNextInvoice: PreviewNextInvoice,
        ): Promise<SubscriptionInvoicePreviewFragment>;
        previewSubscription(
            previewSubscription: PreviewSubscription,
        ): Promise<SubscriptionPreviewV2>;
        revokePromotionalEntitlements(
            input: RevokePromotionalEntitlementInput,
        ): Promise<{ id: string }>;
        revokePromotionalEntitlementsGroup(
            input: RevokePromotionalEntitlementsGroupInput,
        ): Promise<PromotionalEntitlementFragment[]>;
        saveAutomaticRechargeConfiguration(
            input: SaveAutoRechargeSettingsInput,
        ): Promise<AutoRechargeSettingsFragment>;
        transferSubscription(
            input: TransferSubscriptionInput,
        ): Promise<Subscription>;
        transferSubscriptionToResource(
            input: TransferSubscriptionToResourceInput,
        ): Promise<Subscription>;
        unlinkPromotionalEntitlementsGroup(
            input: UnlinkPromotionalEntitlementsGroupInput,
        ): Promise<PromotionalEntitlementFragment[]>;
        voidCreditGrant(
            input: VoidCreditGrantInput,
        ): Promise<CreditGrantFragment | undefined>;
    }

    Implemented by

    Index

    Properties

    applySubscription archiveCustomer cancelSubscription cancelSubscriptionScheduledUpdates createCustomer createSubscription detachCustomerPaymentMethod getCustomer importCustomer importCustomerBulk importSubscriptionBulk provisionCustomer provisionSubscription unarchiveCustomer updateCustomer updateSubscription

    Methods

    delegateSubscriptionToCustomer estimateSubscription estimateSubscriptionUpdate getActiveSubscriptions getActiveSubscriptionsList getAutomaticRechargeConfiguration getCoupons getCreditBalance getCreditGrants getCreditLedger getCreditUsage getCustomerStatistics getPaywall getProducts getSubscription getSubscriptions getUsageHistoryV2 grantCredits grantPromotionalEntitlements grantPromotionalEntitlementsGroup previewNextInvoice previewSubscription revokePromotionalEntitlements revokePromotionalEntitlementsGroup saveAutomaticRechargeConfiguration transferSubscription transferSubscriptionToResource unlinkPromotionalEntitlementsGroup voidCreditGrant

    Properties

    applySubscription: (
        params: ApplySubscription,
    ) => Promise<ApplySubscriptionResults>
    archiveCustomer: (customerId: string) => Promise<string>
    cancelSubscription: (
        cancelSubscription: CancelSubscription,
    ) => Promise<Subscription>
    cancelSubscriptionScheduledUpdates: (
        cancelSubscriptionScheduledUpdates: CancelSubscriptionScheduledUpdates,
    ) => Promise<{ subscriptionId: string }>
    createCustomer: (params: CreateCustomer) => Promise<SlimCustomer>

    use provisionCustomer instead to create both customer and subscription in single operation. See provisionCustomer for more info.

    createSubscription: (
        createSubscription: CreateSubscription,
    ) => Promise<Subscription>

    use provisionSubscription instead to create subscription or checkout session according to customer and subscription payment requirements. See provisionSubscription for more info.

    detachCustomerPaymentMethod: (customerId: string) => Promise<SlimCustomer>
    getCustomer: (customerId: string) => Promise<FullCustomer>
    importCustomer: (params: ImportCustomer) => Promise<SlimCustomer>
    importCustomerBulk: (params: ImportCustomerBulk) => Promise<void>
    importSubscriptionBulk: (params: ImportSubscriptionBulk) => Promise<void>
    provisionCustomer: (params: ProvisionCustomer) => Promise<ProvisionedCustomer>
    provisionSubscription: (
        provisionSubscription: ProvisionSubscription,
    ) => Promise<ProvisionSubscriptionResult>
    unarchiveCustomer: (customerId: string) => Promise<SlimCustomer>
    updateCustomer: (params: UpdateCustomer) => Promise<SlimCustomer>
    updateSubscription: (
        updateSubscription: UpdateSubscription,
    ) => Promise<Subscription>

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR