@sixtyninecommerce/admin 0.10.0 → 0.11.0

package/dist/subscriptions/index.d.ts

@@ -0,0 +1,682 @@
+/**
+ * `admin.subscriptions`: subscription plans and the subscriptions sold on them (headless spec
+ * §9.2 `subscriptions`; plans W10-36, lifecycle W10-114). It reads subscriptions, manages plans,
+ * and runs the lifecycle and billing commands (purchase, pause/resume/cancel, payment recovery
+ * and reconciliation, renewal and settlement retries, price changes), each command that can
+ * charge, refund or change what a customer pays under one idempotency key per attempt (see
+ * `SubscriptionLifecycleCommands`).
+ *
+ * A plan is a store's template: a price per billing interval, the products each cycle ships, and
+ * the commitment rules. Changing or deleting a plan never changes a subscription already sold on
+ * it: each subscription keeps its own `recurringPrice` and products.
+ *
+ * **Money** is an integer in minor units of `currencyCode`. A plan's `price` and a subscription's
+ * `recurringPrice` are on the store's price basis (`readiness().pricesIncludeTax`: gross with VAT
+ * and shipping on a tax-inclusive store, net with net shipping otherwise). What a cycle actually
+ * charged (`billingCycles[].amount`, `upcomingPayment.amount`) is always gross.
+ *
+ * **Status words** are the meta catalog's `labels.subscription_status` keys (`active`,
+ * `past_due`, …): the SDK lower-cases the engine's enum, as it does a mandate's status. Every
+ * value set grows over time: treat a word this version does not name as one with no action.
+ *
+ * **Refusals** (`PlatformError`, by `code`) pass through as the engine sent them:
+ * `SUBSCRIPTION_PLAN_NOT_FOUND` (404), `SUBSCRIPTION_INPUT_INVALID` (400, the sentence names the
+ * value), `SUBSCRIPTION_PLAN_IN_USE` (422), `SUBSCRIPTION_PRODUCT_UNAVAILABLE` (422),
+ * `PLUGIN_ACCESS_DENIED` (403, the store has no subscriptions entitlement), and
+ * `HUB_HAS_NO_ORDERS` / `ORGANIZATION_WORKSPACE_NOT_A_STORE`. Another store's plan, subscription
+ * or customer is not found (a read answers null or an empty list), never served.
+ */
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+/** The meta catalog's `labels.subscription_status` keys. */
+export declare const SUBSCRIPTION_STATUSES: readonly ["incomplete", "trial", "active", "paused", "past_due", "cancelled", "expired", "completed"];
+export type SubscriptionStatus = (typeof SUBSCRIPTION_STATUSES)[number];
+export type SubscriptionBillingInterval = 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+/** `physical`: each cycle ships, at the plan's shipping method. `digital`: nothing ships. */
+export type SubscriptionFulfillmentMode = 'digital' | 'physical';
+/** `immediate`: the first cycle is charged at purchase; `after_interval`: one interval later. */
+export type SubscriptionFirstChargeTiming = 'immediate' | 'after_interval';
+/** A payment mandate's status, lower-cased: `pending`, `valid`, `invalid`, `revoked`. */
+export type PaymentMandateStatus = 'pending' | 'valid' | 'invalid' | 'revoked';
+export interface SubscriptionPlanVariant {
+    id: string;
+    variantId: string;
+    quantity: number;
+    position: number;
+}
+export interface SubscriptionPlan {
+    id: string;
+    channelId: string;
+    name: string;
+    description: string | null;
+    billingInterval: SubscriptionBillingInterval;
+    billingIntervalCount: number;
+    currencyCode: string;
+    /** Per cycle, minor units, on the store's price basis (see the module header). */
+    price: number;
+    trialDays: number;
+    firstChargeTiming: SubscriptionFirstChargeTiming;
+    /** How many hours before a renewal the customer can no longer change it. */
+    customerChangeCutoffHours: number;
+    minCycles: number | null;
+    maxCycles: number | null;
+    enabled: boolean;
+    fulfillmentMode: SubscriptionFulfillmentMode;
+    shippingMethodId: string | null;
+    /** The products each cycle ships, in order. */
+    variants: SubscriptionPlanVariant[];
+    activeSubscriptionCount: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SubscriptionPlanList {
+    items: SubscriptionPlan[];
+    totalItems: number;
+}
+export interface SubscriptionPlanVariantInput {
+    variantId: string;
+    quantity: number;
+}
+export interface CreateSubscriptionPlanInput {
+    name: string;
+    description?: string | null;
+    billingInterval: SubscriptionBillingInterval;
+    billingIntervalCount?: number;
+    currencyCode: string;
+    price: number;
+    trialDays?: number;
+    firstChargeTiming?: SubscriptionFirstChargeTiming;
+    customerChangeCutoffHours?: number;
+    minCycles?: number | null;
+    maxCycles?: number | null;
+    enabled?: boolean;
+    fulfillmentMode?: SubscriptionFulfillmentMode;
+    shippingMethodId?: string | null;
+    variants: SubscriptionPlanVariantInput[];
+}
+/** Only what is sent changes; `null` clears a nullable field. The products: `plans.setVariants`. */
+export type UpdateSubscriptionPlanInput = Partial<Omit<CreateSubscriptionPlanInput, 'variants' | 'currencyCode'>>;
+export interface SubscriptionPlanPriceBreakdownInput {
+    /** Minor units on the store's price basis. */
+    price: number;
+    variants: SubscriptionPlanVariantInput[];
+    fulfillmentMode: SubscriptionFulfillmentMode;
+    shippingMethodId?: string | null;
+}
+/** What a plan price comes to at the store's default tax zone, priced like a subscription order. */
+export interface SubscriptionPlanPriceBreakdown {
+    pricesIncludeTax: boolean;
+    netAmount: number;
+    taxAmount: number;
+    grossAmount: number;
+    currencyCode: string;
+    /** The default tax zone's name; null when the store has none. */
+    zoneName: string | null;
+}
+export interface PaymentMandate {
+    id: string;
+    channelId: string;
+    customerId: string;
+    /** The payment provider's code (`mollie`, `stripe`, …). */
+    provider: string;
+    mandateMethod: string | null;
+    mandateStatus: PaymentMandateStatus;
+    isDefault: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A mandate as a subscription carries it. */
+export type SubscriptionMandate = Pick<PaymentMandate, 'id' | 'provider' | 'mandateMethod' | 'mandateStatus'> & {
+    isDefault?: boolean;
+};
+/** What the store has set up for subscription billing. */
+export interface SubscriptionChannelReadiness {
+    /** The store's price basis: plan prices are gross when true, net otherwise. */
+    pricesIncludeTax: boolean;
+    /** Whether hosted checkouts have a storefront URL to return to. */
+    storefrontUrlConfigured: boolean;
+    managementUrlConfigured: boolean;
+    /** Each provider, and whether the store has a configured and enabled payment method for it. */
+    providers: Array<{
+        code: string;
+        configured: boolean;
+        enabled: boolean;
+    }>;
+}
+/** A subscription as a list (and a customer's subscriptions) answers it. */
+export interface SubscriptionListItem {
+    id: string;
+    channelId: string;
+    customerId: string;
+    customerName: string;
+    paidCycleCount: number;
+    currencyCode: string;
+    /** Per cycle, minor units, on the store's price basis. */
+    recurringPrice: number;
+    billingInterval: SubscriptionBillingInterval;
+    billingIntervalCount: number;
+    /** Null for a subscription the engine has not given a status yet. */
+    currentStatus: SubscriptionStatus | null;
+    currentCycle: number;
+    currentPeriodStart: string | null;
+    currentPeriodEnd: string | null;
+    nextRenewalAt: string | null;
+    lastRenewedAt: string | null;
+    cancelAtPeriodEnd: boolean;
+    createdAt: string;
+    /** Why the subscription needs staff attention, when it does. */
+    attentionSummary: string | null;
+    plan: {
+        id: string;
+        name: string;
+        price: number;
+        maxCycles: number | null;
+    };
+    mandate: SubscriptionMandate;
+    /** Set when the caller's customer-data level withheld part of the answer (the name). */
+    redacted?: true;
+}
+export interface SubscriptionBillingAttempt {
+    id: string;
+    attemptNumber: number;
+    paymentState: string | null;
+    paymentProvider: string;
+    providerPaymentId: string | null;
+    providerSessionId: string | null;
+    failureReason: string | null;
+    checkoutUrl: string | null;
+    nextRetryAt: string | null;
+    createdAt: string;
+}
+/** A billing cycle with its frozen charge and its collection attempts. */
+export interface SubscriptionBillingCycle {
+    id: string;
+    cycleNumber: number;
+    dueAt: string;
+    periodStart: string;
+    periodEnd: string;
+    /** Gross, as charged. */
+    amount: number;
+    currencyCode: string;
+    paymentState: string;
+    settlementState: string;
+    attentionReason: string | null;
+    orderId: string | null;
+    orderCode: string | null;
+    paidAt: string | null;
+    settledAt: string | null;
+    nextRetryAt: string | null;
+    attempts: SubscriptionBillingAttempt[];
+}
+/** A subscription email in the outbox: queued, retrying, parked or recently sent. */
+export interface SubscriptionNotification {
+    id: string;
+    event: string;
+    dueAt: string;
+    dispatchedAt: string | null;
+    failureCount: number;
+    lastError: string | null;
+    nextAttemptAt: string | null;
+    parkedAt: string | null;
+    parkedReason: string | null;
+}
+export interface SubscriptionRenewal {
+    id: string;
+    cycleNumber: number;
+    cycleId: string | null;
+    attemptNumber: number;
+    paymentState: string | null;
+    orderId: string | null;
+    paymentProvider: string;
+    providerPaymentId: string | null;
+    amount: number;
+    currencyCode: string;
+    result: string;
+    failureReason: string | null;
+    retryCount: number;
+    createdAt: string;
+}
+/** One subscription, as `get` answers it. */
+export interface Subscription extends Omit<SubscriptionListItem, 'plan' | 'paidCycleCount' | 'attentionSummary'> {
+    paidCycleCount: number;
+    trialEndsAt: string | null;
+    customerChangeCutoffHours: number;
+    cutoffAt: string | null;
+    cancellationRequested: boolean;
+    cancellationEffectiveAt: string | null;
+    earliestCancellationAt: string | null;
+    remainingPaidCycles: number;
+    committedPayment: boolean;
+    resumeAt: string | null;
+    retainedResumeAt: string | null;
+    earliestResumeAt: string;
+    /** Whether the customer must act on a hosted checkout. */
+    paymentActionRequired: boolean;
+    /** What the engine allows now, with its reason when it does not. Show the buttons from it. */
+    allowedActions: Array<{
+        action: string;
+        allowed: boolean;
+        reason: string | null;
+    }>;
+    /** What each cycle ships. */
+    products: Array<{
+        variantId: string;
+        quantity: number;
+        name: string;
+        sku: string;
+    }>;
+    upcomingPayment: {
+        purchaseId: string | null;
+        dueAt: string | null;
+        /** Gross. */
+        amount: number;
+        currencyCode: string;
+        state: string;
+        nextRetryAt: string | null;
+        checkoutUrl: string | null;
+    };
+    activity: Array<{
+        id: string;
+        action: string;
+        actor: string | null;
+        reason: string | null;
+        createdAt: string;
+    }>;
+    /** Newest first. */
+    billingCycles: SubscriptionBillingCycle[];
+    notifications: SubscriptionNotification[];
+    minCycles: number | null;
+    maxCycles: number | null;
+    cancelAt: string | null;
+    externalId: string | null;
+    externalPlatform: string | null;
+    updatedAt: string;
+    plan: Omit<SubscriptionPlan, 'variants' | 'activeSubscriptionCount' | 'channelId' | 'minCycles' | 'maxCycles' | 'fulfillmentMode' | 'shippingMethodId' | 'createdAt' | 'updatedAt'>;
+    renewalHistory: SubscriptionRenewal[];
+}
+export interface SubscriptionList {
+    items: SubscriptionListItem[];
+    totalItems: number;
+}
+export interface SubscriptionListOptions {
+    /** Matches the customer's name or email, the plan's name, or the subscription's id. */
+    search?: string;
+    /** Only subscriptions that need staff attention. */
+    needsAttention?: boolean;
+    status?: SubscriptionStatus;
+    customerId?: string;
+    planId?: string;
+    take?: number;
+    skip?: number;
+}
+/**
+ * A lifecycle change, as `previewChange` reads it and `manage` / `cancel` make it:
+ * - `pause`: stop renewals, until `date` when given (an indefinite pause otherwise);
+ * - `resume`: renew again, from `date` when given;
+ * - `skip`: skip the next cycle;
+ * - `reschedule`: move the next payment to `date`;
+ * - `undoCancellation`: withdraw a requested cancellation;
+ * - `cancel`: request cancellation at the earliest date the commitment allows;
+ * - `cancelImmediately`: staff only, end it now (needs `overrideReason` unless still in its trial
+ *   or setup).
+ */
+export type SubscriptionChangeAction = 'pause' | 'resume' | 'skip' | 'reschedule' | 'undoCancellation' | 'cancel' | 'cancelImmediately';
+/** The actions `manage` makes; cancelling is `cancel`. */
+export type SubscriptionManageAction = Exclude<SubscriptionChangeAction, 'cancel' | 'cancelImmediately'>;
+export interface SubscriptionChange {
+    action: SubscriptionChangeAction;
+    /**
+     * An ISO-8601 instant WITH its offset (`2026-10-25T09:00:00+01:00`); a wall clock without one
+     * is refused before anything is sent (spec §9.3). Build it in the store's time zone
+     * (`tenant.timeZone()`): the day a merchant picks is the store's day.
+     */
+    date?: string | null;
+    /** Recorded in the subscription's activity. */
+    reason?: string | null;
+    /** Staff only: why the customer change cutoff (or cancellation timing) is overridden. */
+    overrideReason?: string | null;
+}
+/** What a change would do, before it is made. */
+export interface SubscriptionChangePreview {
+    allowed: boolean;
+    /** Why it is not allowed, or what it would cost (a committed payment). */
+    reason: string | null;
+    nextRenewalAt: string | null;
+    cancellationEffectiveAt: string | null;
+    /** A payment already committed stays payable. */
+    committedPayment: boolean;
+    remainingPaidCycles: number;
+}
+/** What a purchase would charge, priced for the customer like the order it will make. */
+export interface SubscriptionPurchasePreview {
+    planId: string;
+    planName: string;
+    /** Gross, charged per cycle (minor units). */
+    amount: number;
+    /** The store's price basis (plan prices gross when true). */
+    pricesIncludeTax: boolean;
+    /** `amount` without tax. */
+    netAmount: number;
+    /** The tax in `amount` for the customer's zone (0 under reverse charge). */
+    taxAmount: number;
+    currencyCode: string;
+    firstPaymentAt: string;
+    firstChargeTiming: SubscriptionFirstChargeTiming;
+    billingInterval: SubscriptionBillingInterval;
+    billingIntervalCount: number;
+    trialDays: number;
+    trialEndsAt: string | null;
+    minCycles: number | null;
+    maxCycles: number | null;
+    customerChangeCutoffHours: number;
+    cutoffAt: string | null;
+    /** What a new payment method's verification charges (a provider's minimum). */
+    mandateVerificationAmount: number;
+    products: Array<{
+        variantId: string;
+        name: string;
+        quantity: number;
+    }>;
+}
+export interface SubscriptionPurchasePreviewInput {
+    planId: string;
+    customerId: string;
+    /** A new payment method through this provider's hosted checkout. */
+    provider?: string | null;
+    /** Or one of the customer's saved, valid mandates. */
+    mandateId?: string | null;
+}
+export interface StartSubscriptionPurchaseInput extends SubscriptionPurchasePreviewInput {
+    /**
+     * The previewed `amount`. When given, the purchase is refused before anything is kept or sent
+     * to a provider (`SUBSCRIPTION_PREVIEW_CONFLICT`) unless the first order charges exactly this.
+     */
+    expectedAmount?: number | null;
+    /** Where a hosted checkout returns; the store's storefront when omitted. */
+    returnUrl?: string | null;
+    /** Email the hosted checkout link to the customer. */
+    sendPaymentEmail?: boolean;
+}
+/**
+ * A purchase, a payment method replacement or a payment recovery: what the customer must do (a
+ * hosted checkout), and where it stands. `state` is the engine's (`reserved`, `processing`,
+ * `action_required`, `complete`, `failed`, `unknown`, …); confirmation comes from the provider.
+ */
+export interface SubscriptionPurchase {
+    id: string;
+    subscriptionId: string;
+    state: string;
+    checkoutUrl: string | null;
+    expiresAt: string | null;
+    currentStatus: SubscriptionStatus | null;
+    paymentActionRequired: boolean;
+    nextRenewalAt: string | null;
+}
+export interface SubscriptionPurchaseModule {
+    /**
+     * What a purchase would charge this customer per cycle, and when. Needs `ReadOrder`.
+     *
+     * @effect read
+     */
+    preview(input: SubscriptionPurchasePreviewInput, options?: Call): Promise<SubscriptionPurchasePreview>;
+    /**
+     * Sell a plan to a customer. Needs `UpdateOrder`. With a saved mandate the first payment is
+     * collected now; with a provider the answer carries the hosted checkout the customer pays.
+     * One key per purchase (`options.idempotencyKey`, minted when omitted): a repeat under it
+     * answers the first purchase, never a second one; another request under it is refused
+     * `SUBSCRIPTION_REQUEST_KEY_CONFLICT`.
+     *
+     * @effect money
+     */
+    start(input: StartSubscriptionPurchaseInput, options?: Call): Promise<SubscriptionPurchase>;
+    /**
+     * Where a purchase, replacement or recovery stands now. Needs `ReadOrder`.
+     *
+     * @effect read
+     */
+    status(purchaseId: string, options?: Call): Promise<SubscriptionPurchase>;
+    /**
+     * Staff reconciliation of a purchase's checkout whose outcome is unknown: verify the
+     * provider's reference, or (`reopen`) record that no payment exists so it can be started
+     * again. `investigationReason` (20+ characters) is recorded. Needs `UpdateOrder`. Keyed like
+     * `start`.
+     *
+     * @effect money
+     */
+    reconcile(purchaseId: string, input: {
+        investigationReason: string;
+        providerReference?: string | null;
+        reopen?: boolean;
+    }, options?: Call): Promise<void>;
+}
+/**
+ * The lifecycle and billing commands (headless W10-114). Every command that can charge, refund or
+ * change what a customer pays takes one idempotency key per attempt (`options.idempotencyKey`,
+ * minted when omitted): mint it when the merchant starts the action and send the SAME key when
+ * repeating that attempt. A repeat answers the first call's result and never acts again; another
+ * request under the key is refused `SUBSCRIPTION_REQUEST_KEY_CONFLICT` (409). A key whose first
+ * call is still running answers `IDEMPOTENCY_IN_PROGRESS` (409: repeat it later); one whose
+ * first call failed without an answer answers `IDEMPOTENCY_OUTCOME_UNKNOWN` (409,
+ * `outcomeUnknown`): read the subscription back, reconcile, and act again with a new key.
+ */
+export interface SubscriptionLifecycleCommands {
+    purchase: SubscriptionPurchaseModule;
+    /**
+     * What a change would do now, without making it. Needs `ReadOrder`.
+     *
+     * @effect read
+     */
+    previewChange(subscriptionId: string, change: SubscriptionChange, options?: Call): Promise<SubscriptionChangePreview>;
+    /**
+     * Pause, resume, skip, reschedule, or withdraw a cancellation. Each changes when, or whether,
+     * the customer is charged next. Needs `UpdateOrder`. `cancel` and `cancelImmediately` are
+     * refused here (`SUBSCRIPTION_INPUT_INVALID`): use `cancel`.
+     *
+     * @effect money
+     */
+    manage(subscriptionId: string, change: SubscriptionChange & {
+        action: SubscriptionManageAction;
+    }, options?: Call): Promise<Subscription>;
+    /**
+     * Cancel: at the earliest date the commitment allows, or (`immediately`, staff) now. An
+     * immediate cancellation outside the trial or setup needs `overrideReason`. Needs `UpdateOrder`.
+     *
+     * @effect destructive
+     */
+    cancel(subscriptionId: string, input?: {
+        immediately?: boolean;
+        reason?: string | null;
+        overrideReason?: string | null;
+    }, options?: Call): Promise<Subscription>;
+    /**
+     * Replace the payment method through a provider's hosted checkout; the subscription changes
+     * only after the new method is verified. Needs `UpdateOrder`.
+     *
+     * @effect money
+     */
+    replaceMandate(subscriptionId: string, input: {
+        provider: string;
+        returnUrl?: string | null;
+    }, options?: Call): Promise<SubscriptionPurchase>;
+    /**
+     * A hosted payment link for the outstanding cycle; it is paid once. Needs `UpdateOrder`.
+     *
+     * @effect money
+     */
+    recoverPayment(subscriptionId: string, input?: {
+        returnUrl?: string | null;
+    }, options?: Call): Promise<SubscriptionPurchase>;
+    /**
+     * Staff vouch for a provider payment on an attempt whose outcome is unknown: the engine reads
+     * the reference back and checks tenant, customer, amount and currency before the cycle takes
+     * it. `investigationReason` (20+ characters) is recorded. Needs `UpdateOrder`.
+     *
+     * @effect money
+     */
+    reconcilePayment(subscriptionId: string, input: {
+        attemptId: string;
+        providerReference: string;
+        investigationReason: string;
+    }, options?: Call): Promise<Subscription>;
+    /**
+     * Staff record that an unknown attempt created no payment: the cycle fails and is collected
+     * again by the retry schedule. Needs `UpdateOrder`.
+     *
+     * @effect money
+     */
+    reopenUnknownPayment(subscriptionId: string, input: {
+        attemptId: string;
+        investigationReason: string;
+    }, options?: Call): Promise<Subscription>;
+    /**
+     * Collect the outstanding cycle again now: one provider payment attempt per key. Answers the
+     * latest attempt (its `paymentState`: `paid`, `failed`, `unknown`, …). Needs `UpdateOrder`.
+     *
+     * @effect money
+     */
+    retryRenewal(subscriptionId: string, options?: Call): Promise<SubscriptionRenewal>;
+    /**
+     * Settle a paid cycle's order (records the payment on it); never a new provider payment.
+     * Answers the cycle: `settled`, or still `attention` with the reason. Needs `UpdateOrder`.
+     *
+     * @effect money
+     */
+    retrySettlement(subscriptionId: string, options?: Call): Promise<SubscriptionBillingCycle>;
+    /**
+     * Clear a cycle's attention flag once staff handled it at the provider (a refund, a partial
+     * chargeback review). The payment it was about stops counting as money the cycle holds, so a
+     * later recovery can charge again. `reason` (20+ characters) is recorded. Needs `UpdateOrder`.
+     *
+     * @effect money
+     */
+    clearAttention(cycleId: string, reason: string, options?: Call): Promise<SubscriptionBillingCycle>;
+    /**
+     * Change what each renewal charges (minor units, on the store's price basis). Needs
+     * `UpdateOrder`.
+     *
+     * @effect money
+     */
+    updatePrice(subscriptionId: string, newPrice: number, options?: Call): Promise<Subscription>;
+}
+export interface SubscriptionPlansModule {
+    /**
+     * The store's plans, newest first. Needs `ReadOrder`.
+     *
+     * @effect read
+     */
+    list(options?: {
+        enabled?: boolean;
+        take?: number;
+        skip?: number;
+    } & Call): Promise<SubscriptionPlanList>;
+    /**
+     * One plan, or null when the store has none by that id (another store's included). Needs
+     * `ReadOrder`.
+     *
+     * @effect read
+     */
+    get(planId: string, options?: Call): Promise<SubscriptionPlan | null>;
+    /**
+     * Create a plan with its products. Needs `UpdateOrder`. A product the store does not sell is
+     * refused (`SUBSCRIPTION_PRODUCT_UNAVAILABLE`), as is a malformed value
+     * (`SUBSCRIPTION_INPUT_INVALID`). Moves no money: nothing is sold until a purchase.
+     *
+     * @effect write
+     */
+    create(input: CreateSubscriptionPlanInput, options?: Call): Promise<SubscriptionPlan>;
+    /**
+     * Change a plan. Needs `UpdateOrder`. Subscriptions already sold on it keep their own price and
+     * products.
+     *
+     * @effect write
+     */
+    update(planId: string, input: UpdateSubscriptionPlanInput, options?: Call): Promise<SubscriptionPlan>;
+    /**
+     * Replace the plan's products with exactly these, in this order. Needs `UpdateOrder`.
+     * Subscriptions already sold on it keep their own products.
+     *
+     * @effect write
+     */
+    setVariants(planId: string, variants: readonly SubscriptionPlanVariantInput[], options?: Call): Promise<SubscriptionPlan>;
+    /**
+     * Delete a plan for good. Needs `DeleteOrder`. A plan that has subscriptions is refused
+     * (`SUBSCRIPTION_PLAN_IN_USE`: disable it instead); one this store does not have is refused
+     * `SUBSCRIPTION_PLAN_NOT_DELETED` (`ConflictError`, 409, as every `*_NOT_DELETED` of this SDK)
+     * with the engine's reason.
+     *
+     * @effect destructive
+     */
+    delete(planId: string, options?: Call): Promise<void>;
+    /**
+     * What a plan price comes to at the store's default tax zone, priced exactly like a
+     * subscription order (the plan form's helper text). Needs `UpdateOrder`.
+     *
+     * @effect read
+     */
+    priceBreakdown(input: SubscriptionPlanPriceBreakdownInput, options?: Call): Promise<SubscriptionPlanPriceBreakdown>;
+}
+export interface SubscriptionsModule extends SubscriptionLifecycleCommands {
+    plans: SubscriptionPlansModule;
+    /**
+     * A page of the store's subscriptions, newest first. Needs `ReadOrder`. An unknown `status`
+     * is refused before anything is sent (`SUBSCRIPTION_INPUT_INVALID`).
+     *
+     * @effect read
+     */
+    list(options?: SubscriptionListOptions & Call): Promise<SubscriptionList>;
+    /**
+     * One subscription with its cycles, attempts, outbox, activity and what the engine allows now;
+     * null when the store has none by that id (another store's included). Needs `ReadOrder`.
+     *
+     * @effect read
+     */
+    get(subscriptionId: string, options?: Call): Promise<Subscription | null>;
+    /**
+     * Every subscription of one customer of this store (empty for another store's customer).
+     * Needs `ReadOrder`.
+     *
+     * @effect read
+     */
+    forCustomer(customerId: string, options?: Call): Promise<SubscriptionListItem[]>;
+    /**
+     * The customer's payment mandates in this store, the ones a purchase can charge. Needs
+     * `ReadOrder`.
+     *
+     * @effect read
+     */
+    mandates(customerId: string, options?: Call): Promise<PaymentMandate[]>;
+    /**
+     * What the store has set up for subscription billing: its price basis, whether hosted
+     * checkouts can return to a storefront, and which providers can take a payment now.
+     *
+     * @effect read
+     */
+    readiness(options?: Call): Promise<SubscriptionChannelReadiness>;
+}
+export declare const SUBSCRIPTION_PLANS_QUERY = "\n  query SubscriptionsPlansList($options: SubscriptionPlanListOptions) {\n    subscriptionPlans(options: $options) {\n      items {\n        \n  id\n  channelId\n  name\n  description\n  billingInterval\n  billingIntervalCount\n  currencyCode\n  price\n  trialDays\n  firstChargeTiming\n  customerChangeCutoffHours\n  minCycles\n  maxCycles\n  enabled\n  fulfillmentMode\n  shippingMethodId\n  activeSubscriptionCount\n  createdAt\n  updatedAt\n  variants {\n    id\n    variantId\n    quantity\n    position\n  }\n\n      }\n      totalItems\n    }\n  }\n";
+export declare const SUBSCRIPTION_PLAN_QUERY = "\n  query SubscriptionsPlansGet($id: ID!) {\n    subscriptionPlan(id: $id) {\n      \n  id\n  channelId\n  name\n  description\n  billingInterval\n  billingIntervalCount\n  currencyCode\n  price\n  trialDays\n  firstChargeTiming\n  customerChangeCutoffHours\n  minCycles\n  maxCycles\n  enabled\n  fulfillmentMode\n  shippingMethodId\n  activeSubscriptionCount\n  createdAt\n  updatedAt\n  variants {\n    id\n    variantId\n    quantity\n    position\n  }\n\n    }\n  }\n";
+export declare const CREATE_SUBSCRIPTION_PLAN_MUTATION = "\n  mutation SubscriptionsPlansCreate($input: CreateSubscriptionPlanInput!) {\n    createSubscriptionPlan(input: $input) {\n      \n  id\n  channelId\n  name\n  description\n  billingInterval\n  billingIntervalCount\n  currencyCode\n  price\n  trialDays\n  firstChargeTiming\n  customerChangeCutoffHours\n  minCycles\n  maxCycles\n  enabled\n  fulfillmentMode\n  shippingMethodId\n  activeSubscriptionCount\n  createdAt\n  updatedAt\n  variants {\n    id\n    variantId\n    quantity\n    position\n  }\n\n    }\n  }\n";
+export declare const UPDATE_SUBSCRIPTION_PLAN_MUTATION = "\n  mutation SubscriptionsPlansUpdate($id: ID!, $input: UpdateSubscriptionPlanInput!) {\n    updateSubscriptionPlan(id: $id, input: $input) {\n      \n  id\n  channelId\n  name\n  description\n  billingInterval\n  billingIntervalCount\n  currencyCode\n  price\n  trialDays\n  firstChargeTiming\n  customerChangeCutoffHours\n  minCycles\n  maxCycles\n  enabled\n  fulfillmentMode\n  shippingMethodId\n  activeSubscriptionCount\n  createdAt\n  updatedAt\n  variants {\n    id\n    variantId\n    quantity\n    position\n  }\n\n    }\n  }\n";
+export declare const SET_SUBSCRIPTION_PLAN_VARIANTS_MUTATION = "\n  mutation SubscriptionsPlansSetVariants(\n    $planId: ID!\n    $variants: [SubscriptionPlanVariantInput!]!\n  ) {\n    setSubscriptionPlanVariants(planId: $planId, variants: $variants) {\n      \n  id\n  channelId\n  name\n  description\n  billingInterval\n  billingIntervalCount\n  currencyCode\n  price\n  trialDays\n  firstChargeTiming\n  customerChangeCutoffHours\n  minCycles\n  maxCycles\n  enabled\n  fulfillmentMode\n  shippingMethodId\n  activeSubscriptionCount\n  createdAt\n  updatedAt\n  variants {\n    id\n    variantId\n    quantity\n    position\n  }\n\n    }\n  }\n";
+export declare const DELETE_SUBSCRIPTION_PLAN_MUTATION = "\n  mutation SubscriptionsPlansDelete($id: ID!) {\n    deleteSubscriptionPlan(id: $id) {\n      result\n      message\n    }\n  }\n";
+export declare const SUBSCRIPTION_PLAN_PRICE_BREAKDOWN_QUERY = "\n  query SubscriptionsPlansPriceBreakdown($input: SubscriptionPlanPriceBreakdownInput!) {\n    subscriptionPlanPriceBreakdown(input: $input) {\n      pricesIncludeTax\n      netAmount\n      taxAmount\n      grossAmount\n      currencyCode\n      zoneName\n    }\n  }\n";
+export declare const SUBSCRIPTIONS_QUERY = "\n  query SubscriptionsList($options: SubscriptionListOptions) {\n    subscriptions(options: $options) {\n      items {\n        \n  id\n  channelId\n  customerId\n  customerName\n  paidCycleCount\n  currencyCode\n  recurringPrice\n  billingInterval\n  billingIntervalCount\n  currentStatus\n  currentCycle\n  currentPeriodStart\n  currentPeriodEnd\n  nextRenewalAt\n  lastRenewedAt\n  cancelAtPeriodEnd\n  createdAt\n  attentionSummary\n  plan {\n    id\n    name\n    price\n    maxCycles\n  }\n  mandate {\n    id\n    provider\n    mandateMethod\n    mandateStatus\n  }\n\n      }\n      totalItems\n    }\n  }\n";
+export declare const SUBSCRIPTION_QUERY = "\n  query SubscriptionsGet($id: ID!) {\n    subscription(id: $id) {\n      \n  id\n  channelId\n  customerId\n  customerName\n  paidCycleCount\n  currencyCode\n  recurringPrice\n  billingInterval\n  billingIntervalCount\n  currentStatus\n  trialEndsAt\n  customerChangeCutoffHours\n  cutoffAt\n  cancellationRequested\n  cancellationEffectiveAt\n  earliestCancellationAt\n  remainingPaidCycles\n  committedPayment\n  resumeAt\n  retainedResumeAt\n  earliestResumeAt\n  paymentActionRequired\n  allowedActions { action allowed reason }\n  products { variantId quantity name sku }\n  upcomingPayment { purchaseId dueAt amount currencyCode state nextRetryAt checkoutUrl }\n  activity { id action actor reason createdAt }\n  billingCycles {\n    \n  id cycleNumber dueAt periodStart periodEnd amount currencyCode paymentState settlementState\n  attentionReason orderId orderCode paidAt settledAt nextRetryAt\n  attempts {\n    id attemptNumber paymentState paymentProvider providerPaymentId providerSessionId\n    failureReason checkoutUrl nextRetryAt createdAt\n  }\n\n  }\n  notifications {\n    id event dueAt dispatchedAt failureCount lastError nextAttemptAt parkedAt parkedReason\n  }\n  currentCycle\n  minCycles\n  maxCycles\n  currentPeriodStart\n  currentPeriodEnd\n  nextRenewalAt\n  lastRenewedAt\n  cancelAtPeriodEnd\n  cancelAt\n  externalId\n  externalPlatform\n  createdAt\n  updatedAt\n  plan {\n    id\n    name\n    description\n    billingInterval\n    billingIntervalCount\n    currencyCode\n    price\n    trialDays\n    firstChargeTiming\n    customerChangeCutoffHours\n    enabled\n  }\n  mandate {\n    id\n    provider\n    mandateMethod\n    mandateStatus\n    isDefault\n  }\n  renewalHistory {\n    id\n    cycleNumber\n    cycleId\n    attemptNumber\n    paymentState\n    orderId\n    paymentProvider\n    providerPaymentId\n    amount\n    currencyCode\n    result\n    failureReason\n    retryCount\n    createdAt\n  }\n\n    }\n  }\n";
+export declare const CUSTOMER_SUBSCRIPTIONS_QUERY = "\n  query SubscriptionsForCustomer($customerId: ID!) {\n    customerSubscriptions(customerId: $customerId) {\n      \n  id\n  channelId\n  customerId\n  customerName\n  paidCycleCount\n  currencyCode\n  recurringPrice\n  billingInterval\n  billingIntervalCount\n  currentStatus\n  currentCycle\n  currentPeriodStart\n  currentPeriodEnd\n  nextRenewalAt\n  lastRenewedAt\n  cancelAtPeriodEnd\n  createdAt\n  attentionSummary\n  plan {\n    id\n    name\n    price\n    maxCycles\n  }\n  mandate {\n    id\n    provider\n    mandateMethod\n    mandateStatus\n  }\n\n    }\n  }\n";
+export declare const CUSTOMER_MANDATES_QUERY = "\n  query SubscriptionsMandates($customerId: ID!) {\n    customerMandates(customerId: $customerId) {\n      \n  id\n  channelId\n  customerId\n  provider\n  mandateMethod\n  mandateStatus\n  isDefault\n  createdAt\n  updatedAt\n\n    }\n  }\n";
+export declare const SUBSCRIPTION_CHANNEL_READINESS_QUERY = "\n  query SubscriptionsReadiness {\n    subscriptionChannelReadiness {\n      pricesIncludeTax\n      storefrontUrlConfigured\n      managementUrlConfigured\n      providers {\n        code\n        configured\n        enabled\n      }\n    }\n  }\n";
+export declare const SUBSCRIPTION_PURCHASE_PREVIEW_QUERY = "\n  query SubscriptionsPurchasePreview(\n    $planId: ID!\n    $customerId: ID\n    $provider: String\n    $mandateId: ID\n  ) {\n    subscriptionPurchasePreview(\n      planId: $planId\n      customerId: $customerId\n      provider: $provider\n      mandateId: $mandateId\n    ) {\n      planId\n      planName\n      amount\n      pricesIncludeTax\n      netAmount\n      taxAmount\n      currencyCode\n      firstPaymentAt\n      firstChargeTiming\n      billingInterval\n      billingIntervalCount\n      trialDays\n      trialEndsAt\n      minCycles\n      maxCycles\n      customerChangeCutoffHours\n      cutoffAt\n      mandateVerificationAmount\n      products {\n        variantId\n        name\n        quantity\n      }\n    }\n  }\n";
+export declare const START_SUBSCRIPTION_PURCHASE_MUTATION = "\n  mutation SubscriptionsPurchaseStart($input: SubscriptionPurchaseInput!) {\n    startSubscriptionPurchase(input: $input) {\n      \n  id\n  subscriptionId\n  state\n  checkoutUrl\n  expiresAt\n  currentStatus\n  paymentActionRequired\n  nextRenewalAt\n\n    }\n  }\n";
+export declare const SUBSCRIPTION_PURCHASE_STATUS_QUERY = "\n  query SubscriptionsPurchaseStatus($id: ID!) {\n    subscriptionPurchaseStatus(id: $id) {\n      \n  id\n  subscriptionId\n  state\n  checkoutUrl\n  expiresAt\n  currentStatus\n  paymentActionRequired\n  nextRenewalAt\n\n    }\n  }\n";
+export declare const RECONCILE_SUBSCRIPTION_PURCHASE_MUTATION = "\n  mutation SubscriptionsPurchaseReconcile(\n    $id: ID!\n    $requestKey: String!\n    $investigationReason: String!\n    $providerReference: String\n    $reopen: Boolean\n  ) {\n    reconcileSubscriptionPurchase(\n      id: $id\n      requestKey: $requestKey\n      investigationReason: $investigationReason\n      providerReference: $providerReference\n      reopen: $reopen\n    )\n  }\n";
+export declare const PREVIEW_SUBSCRIPTION_CHANGE_QUERY = "\n  query SubscriptionsPreviewChange($id: ID!, $input: SubscriptionLifecycleCommand!) {\n    previewSubscriptionChange(id: $id, input: $input) {\n      allowed\n      reason\n      nextRenewalAt\n      cancellationEffectiveAt\n      committedPayment\n      remainingPaidCycles\n    }\n  }\n";
+export declare const MANAGE_SUBSCRIPTION_MUTATION = "\n  mutation SubscriptionsManage($id: ID!, $input: SubscriptionLifecycleCommand!) {\n    manageSubscription(id: $id, input: $input) {\n      \n  id\n  channelId\n  customerId\n  customerName\n  paidCycleCount\n  currencyCode\n  recurringPrice\n  billingInterval\n  billingIntervalCount\n  currentStatus\n  trialEndsAt\n  customerChangeCutoffHours\n  cutoffAt\n  cancellationRequested\n  cancellationEffectiveAt\n  earliestCancellationAt\n  remainingPaidCycles\n  committedPayment\n  resumeAt\n  retainedResumeAt\n  earliestResumeAt\n  paymentActionRequired\n  allowedActions { action allowed reason }\n  products { variantId quantity name sku }\n  upcomingPayment { purchaseId dueAt amount currencyCode state nextRetryAt checkoutUrl }\n  activity { id action actor reason createdAt }\n  billingCycles {\n    \n  id cycleNumber dueAt periodStart periodEnd amount currencyCode paymentState settlementState\n  attentionReason orderId orderCode paidAt settledAt nextRetryAt\n  attempts {\n    id attemptNumber paymentState paymentProvider providerPaymentId providerSessionId\n    failureReason checkoutUrl nextRetryAt createdAt\n  }\n\n  }\n  notifications {\n    id event dueAt dispatchedAt failureCount lastError nextAttemptAt parkedAt parkedReason\n  }\n  currentCycle\n  minCycles\n  maxCycles\n  currentPeriodStart\n  currentPeriodEnd\n  nextRenewalAt\n  lastRenewedAt\n  cancelAtPeriodEnd\n  cancelAt\n  externalId\n  externalPlatform\n  createdAt\n  updatedAt\n  plan {\n    id\n    name\n    description\n    billingInterval\n    billingIntervalCount\n    currencyCode\n    price\n    trialDays\n    firstChargeTiming\n    customerChangeCutoffHours\n    enabled\n  }\n  mandate {\n    id\n    provider\n    mandateMethod\n    mandateStatus\n    isDefault\n  }\n  renewalHistory {\n    id\n    cycleNumber\n    cycleId\n    attemptNumber\n    paymentState\n    orderId\n    paymentProvider\n    providerPaymentId\n    amount\n    currencyCode\n    result\n    failureReason\n    retryCount\n    createdAt\n  }\n\n    }\n  }\n";
+export declare const REPLACE_SUBSCRIPTION_MANDATE_MUTATION = "\n  mutation SubscriptionsReplaceMandate($id: ID!, $input: SubscriptionPaymentActionInput!) {\n    replaceSubscriptionMandate(id: $id, input: $input) {\n      \n  id\n  subscriptionId\n  state\n  checkoutUrl\n  expiresAt\n  currentStatus\n  paymentActionRequired\n  nextRenewalAt\n\n    }\n  }\n";
+export declare const RECOVER_SUBSCRIPTION_PAYMENT_MUTATION = "\n  mutation SubscriptionsRecoverPayment($id: ID!, $input: SubscriptionPaymentActionInput!) {\n    recoverSubscriptionPayment(id: $id, input: $input) {\n      \n  id\n  subscriptionId\n  state\n  checkoutUrl\n  expiresAt\n  currentStatus\n  paymentActionRequired\n  nextRenewalAt\n\n    }\n  }\n";
+export declare const RECONCILE_SUBSCRIPTION_PAYMENT_MUTATION = "\n  mutation SubscriptionsReconcilePayment(\n    $id: ID!\n    $attemptId: ID!\n    $providerReference: String!\n    $requestKey: String!\n    $investigationReason: String!\n  ) {\n    reconcileSubscriptionPayment(\n      id: $id\n      attemptId: $attemptId\n      providerReference: $providerReference\n      requestKey: $requestKey\n      investigationReason: $investigationReason\n    ) {\n      \n  id\n  channelId\n  customerId\n  customerName\n  paidCycleCount\n  currencyCode\n  recurringPrice\n  billingInterval\n  billingIntervalCount\n  currentStatus\n  trialEndsAt\n  customerChangeCutoffHours\n  cutoffAt\n  cancellationRequested\n  cancellationEffectiveAt\n  earliestCancellationAt\n  remainingPaidCycles\n  committedPayment\n  resumeAt\n  retainedResumeAt\n  earliestResumeAt\n  paymentActionRequired\n  allowedActions { action allowed reason }\n  products { variantId quantity name sku }\n  upcomingPayment { purchaseId dueAt amount currencyCode state nextRetryAt checkoutUrl }\n  activity { id action actor reason createdAt }\n  billingCycles {\n    \n  id cycleNumber dueAt periodStart periodEnd amount currencyCode paymentState settlementState\n  attentionReason orderId orderCode paidAt settledAt nextRetryAt\n  attempts {\n    id attemptNumber paymentState paymentProvider providerPaymentId providerSessionId\n    failureReason checkoutUrl nextRetryAt createdAt\n  }\n\n  }\n  notifications {\n    id event dueAt dispatchedAt failureCount lastError nextAttemptAt parkedAt parkedReason\n  }\n  currentCycle\n  minCycles\n  maxCycles\n  currentPeriodStart\n  currentPeriodEnd\n  nextRenewalAt\n  lastRenewedAt\n  cancelAtPeriodEnd\n  cancelAt\n  externalId\n  externalPlatform\n  createdAt\n  updatedAt\n  plan {\n    id\n    name\n    description\n    billingInterval\n    billingIntervalCount\n    currencyCode\n    price\n    trialDays\n    firstChargeTiming\n    customerChangeCutoffHours\n    enabled\n  }\n  mandate {\n    id\n    provider\n    mandateMethod\n    mandateStatus\n    isDefault\n  }\n  renewalHistory {\n    id\n    cycleNumber\n    cycleId\n    attemptNumber\n    paymentState\n    orderId\n    paymentProvider\n    providerPaymentId\n    amount\n    currencyCode\n    result\n    failureReason\n    retryCount\n    createdAt\n  }\n\n    }\n  }\n";
+export declare const REOPEN_UNKNOWN_SUBSCRIPTION_PAYMENT_MUTATION = "\n  mutation SubscriptionsReopenUnknownPayment(\n    $id: ID!\n    $attemptId: ID!\n    $requestKey: String!\n    $investigationReason: String!\n  ) {\n    reopenUnknownSubscriptionPayment(\n      id: $id\n      attemptId: $attemptId\n      requestKey: $requestKey\n      investigationReason: $investigationReason\n    ) {\n      \n  id\n  channelId\n  customerId\n  customerName\n  paidCycleCount\n  currencyCode\n  recurringPrice\n  billingInterval\n  billingIntervalCount\n  currentStatus\n  trialEndsAt\n  customerChangeCutoffHours\n  cutoffAt\n  cancellationRequested\n  cancellationEffectiveAt\n  earliestCancellationAt\n  remainingPaidCycles\n  committedPayment\n  resumeAt\n  retainedResumeAt\n  earliestResumeAt\n  paymentActionRequired\n  allowedActions { action allowed reason }\n  products { variantId quantity name sku }\n  upcomingPayment { purchaseId dueAt amount currencyCode state nextRetryAt checkoutUrl }\n  activity { id action actor reason createdAt }\n  billingCycles {\n    \n  id cycleNumber dueAt periodStart periodEnd amount currencyCode paymentState settlementState\n  attentionReason orderId orderCode paidAt settledAt nextRetryAt\n  attempts {\n    id attemptNumber paymentState paymentProvider providerPaymentId providerSessionId\n    failureReason checkoutUrl nextRetryAt createdAt\n  }\n\n  }\n  notifications {\n    id event dueAt dispatchedAt failureCount lastError nextAttemptAt parkedAt parkedReason\n  }\n  currentCycle\n  minCycles\n  maxCycles\n  currentPeriodStart\n  currentPeriodEnd\n  nextRenewalAt\n  lastRenewedAt\n  cancelAtPeriodEnd\n  cancelAt\n  externalId\n  externalPlatform\n  createdAt\n  updatedAt\n  plan {\n    id\n    name\n    description\n    billingInterval\n    billingIntervalCount\n    currencyCode\n    price\n    trialDays\n    firstChargeTiming\n    customerChangeCutoffHours\n    enabled\n  }\n  mandate {\n    id\n    provider\n    mandateMethod\n    mandateStatus\n    isDefault\n  }\n  renewalHistory {\n    id\n    cycleNumber\n    cycleId\n    attemptNumber\n    paymentState\n    orderId\n    paymentProvider\n    providerPaymentId\n    amount\n    currencyCode\n    result\n    failureReason\n    retryCount\n    createdAt\n  }\n\n    }\n  }\n";
+export declare const RETRY_SUBSCRIPTION_RENEWAL_MUTATION = "\n  mutation SubscriptionsRetryRenewal($subscriptionId: ID!, $requestKey: String) {\n    retrySubscriptionRenewal(subscriptionId: $subscriptionId, requestKey: $requestKey) {\n      \n  id\n  cycleNumber\n  cycleId\n  attemptNumber\n  paymentState\n  orderId\n  paymentProvider\n  providerPaymentId\n  amount\n  currencyCode\n  result\n  failureReason\n  retryCount\n  createdAt\n\n    }\n  }\n";
+export declare const RETRY_SUBSCRIPTION_SETTLEMENT_MUTATION = "\n  mutation SubscriptionsRetrySettlement($subscriptionId: ID!, $requestKey: String) {\n    retrySubscriptionSettlement(subscriptionId: $subscriptionId, requestKey: $requestKey) {\n      \n  id cycleNumber dueAt periodStart periodEnd amount currencyCode paymentState settlementState\n  attentionReason orderId orderCode paidAt settledAt nextRetryAt\n  attempts {\n    id attemptNumber paymentState paymentProvider providerPaymentId providerSessionId\n    failureReason checkoutUrl nextRetryAt createdAt\n  }\n\n    }\n  }\n";
+export declare const CLEAR_SUBSCRIPTION_CYCLE_ATTENTION_MUTATION = "\n  mutation SubscriptionsClearAttention($cycleId: ID!, $reason: String!, $requestKey: String) {\n    clearSubscriptionCycleAttention(cycleId: $cycleId, reason: $reason, requestKey: $requestKey) {\n      \n  id cycleNumber dueAt periodStart periodEnd amount currencyCode paymentState settlementState\n  attentionReason orderId orderCode paidAt settledAt nextRetryAt\n  attempts {\n    id attemptNumber paymentState paymentProvider providerPaymentId providerSessionId\n    failureReason checkoutUrl nextRetryAt createdAt\n  }\n\n    }\n  }\n";
+export declare const UPDATE_SUBSCRIPTION_PRICE_MUTATION = "\n  mutation SubscriptionsUpdatePrice($id: ID!, $newPrice: Int!, $requestKey: String) {\n    updateSubscriptionPrice(id: $id, newPrice: $newPrice, requestKey: $requestKey) {\n      \n  id\n  channelId\n  customerId\n  customerName\n  paidCycleCount\n  currencyCode\n  recurringPrice\n  billingInterval\n  billingIntervalCount\n  currentStatus\n  trialEndsAt\n  customerChangeCutoffHours\n  cutoffAt\n  cancellationRequested\n  cancellationEffectiveAt\n  earliestCancellationAt\n  remainingPaidCycles\n  committedPayment\n  resumeAt\n  retainedResumeAt\n  earliestResumeAt\n  paymentActionRequired\n  allowedActions { action allowed reason }\n  products { variantId quantity name sku }\n  upcomingPayment { purchaseId dueAt amount currencyCode state nextRetryAt checkoutUrl }\n  activity { id action actor reason createdAt }\n  billingCycles {\n    \n  id cycleNumber dueAt periodStart periodEnd amount currencyCode paymentState settlementState\n  attentionReason orderId orderCode paidAt settledAt nextRetryAt\n  attempts {\n    id attemptNumber paymentState paymentProvider providerPaymentId providerSessionId\n    failureReason checkoutUrl nextRetryAt createdAt\n  }\n\n  }\n  notifications {\n    id event dueAt dispatchedAt failureCount lastError nextAttemptAt parkedAt parkedReason\n  }\n  currentCycle\n  minCycles\n  maxCycles\n  currentPeriodStart\n  currentPeriodEnd\n  nextRenewalAt\n  lastRenewedAt\n  cancelAtPeriodEnd\n  cancelAt\n  externalId\n  externalPlatform\n  createdAt\n  updatedAt\n  plan {\n    id\n    name\n    description\n    billingInterval\n    billingIntervalCount\n    currencyCode\n    price\n    trialDays\n    firstChargeTiming\n    customerChangeCutoffHours\n    enabled\n  }\n  mandate {\n    id\n    provider\n    mandateMethod\n    mandateStatus\n    isDefault\n  }\n  renewalHistory {\n    id\n    cycleNumber\n    cycleId\n    attemptNumber\n    paymentState\n    orderId\n    paymentProvider\n    providerPaymentId\n    amount\n    currencyCode\n    result\n    failureReason\n    retryCount\n    createdAt\n  }\n\n    }\n  }\n";
+export declare function createSubscriptionsModule(transport: Transport): SubscriptionsModule;