autumn-js 1.2.19 → 1.2.21

package/dist/backend/{routeTypes-gNxrwRsV.d.ts → routeTypes-B-Bkse9m.d.ts}

@@ -4686,6 +4686,7 @@ type CreatePlanParams = {
      * Miscellaneous plan-level configuration flags.
      */
     config?: CreatePlanConfigRequest | undefined;
+    createInStripe?: boolean | undefined;
 };
 /**
  * Billing interval (e.g. 'month', 'year').
@@ -6151,6 +6152,7 @@ declare const CustomerRewardsType: {
     readonly FixedDiscount: "fixed_discount";
     readonly FreeProduct: "free_product";
     readonly InvoiceCredits: "invoice_credits";
+    readonly FeatureGrant: "feature_grant";
 };
 /**
  * The type of reward
@@ -7002,6 +7004,7 @@ declare const GetCustomerRewardsType: {
     readonly FixedDiscount: "fixed_discount";
     readonly FreeProduct: "free_product";
     readonly InvoiceCredits: "invoice_credits";
+    readonly FeatureGrant: "feature_grant";
 };
 /**
  * The type of reward
@@ -8130,20 +8133,20 @@ type ListCustomersPlan = {
 /**
  * Filter by customer product status. Defaults to active and scheduled
  */
-declare const SubscriptionStatus: {
+declare const ListCustomersSubscriptionStatus: {
     readonly Active: "active";
     readonly Scheduled: "scheduled";
 };
 /**
  * Filter by customer product status. Defaults to active and scheduled
  */
-type SubscriptionStatus = ClosedEnum<typeof SubscriptionStatus>;
-declare const Processor: {
+type ListCustomersSubscriptionStatus = ClosedEnum<typeof ListCustomersSubscriptionStatus>;
+declare const ListCustomersProcessor: {
     readonly Stripe: "stripe";
     readonly Revenuecat: "revenuecat";
     readonly Vercel: "vercel";
 };
-type Processor = ClosedEnum<typeof Processor>;
+type ListCustomersProcessor = ClosedEnum<typeof ListCustomersProcessor>;
 type ListCustomersParams = {
     /**
      * Number of items to skip
@@ -8160,7 +8163,7 @@ type ListCustomersParams = {
     /**
      * Filter by customer product status. Defaults to active and scheduled
      */
-    subscriptionStatus?: SubscriptionStatus | undefined;
+    subscriptionStatus?: ListCustomersSubscriptionStatus | undefined;
     /**
      * Search customers by id, name, or email
      */
@@ -8168,7 +8171,7 @@ type ListCustomersParams = {
     /**
      * Filter by customer processor type (stripe, revenuecat, vercel)
      */
-    processors?: Array<Processor> | undefined;
+    processors?: Array<ListCustomersProcessor> | undefined;
 };
 /**
  * The environment this customer was created in.
@@ -8685,6 +8688,440 @@ type ListCustomersResponse = {
     totalFilteredCount: number;
 };
 
+type ListEntitiesPlan = {
+    id: string;
+    versions?: Array<number> | undefined;
+};
+/**
+ * Filter customer products used for entity hydration and plan matching. Defaults to active and scheduled.
+ */
+declare const ListEntitiesSubscriptionStatus: {
+    readonly Active: "active";
+    readonly Scheduled: "scheduled";
+};
+/**
+ * Filter customer products used for entity hydration and plan matching. Defaults to active and scheduled.
+ */
+type ListEntitiesSubscriptionStatus = ClosedEnum<typeof ListEntitiesSubscriptionStatus>;
+declare const ListEntitiesProcessor: {
+    readonly Stripe: "stripe";
+    readonly Revenuecat: "revenuecat";
+    readonly Vercel: "vercel";
+};
+type ListEntitiesProcessor = ClosedEnum<typeof ListEntitiesProcessor>;
+type ListEntitiesParams = {
+    /**
+     * Number of items to skip
+     */
+    offset?: number | undefined;
+    /**
+     * Number of items to return. Default 10, max 1000.
+     */
+    limit?: number | undefined;
+    /**
+     * Filter by plan ID and version. Returns entities with active subscriptions to this plan, including plans inherited from the parent customer.
+     */
+    plans?: Array<ListEntitiesPlan> | undefined;
+    /**
+     * Filter customer products used for entity hydration and plan matching. Defaults to active and scheduled.
+     */
+    subscriptionStatus?: ListEntitiesSubscriptionStatus | undefined;
+    /**
+     * Search entities by id or name.
+     */
+    search?: string | undefined;
+    /**
+     * Filter by parent customer processor type (stripe, revenuecat, vercel).
+     */
+    processors?: Array<ListEntitiesProcessor> | undefined;
+};
+/**
+ * The environment (sandbox/live)
+ */
+declare const ListEntitiesEnv: {
+    readonly Sandbox: "sandbox";
+    readonly Live: "live";
+};
+/**
+ * The environment (sandbox/live)
+ */
+type ListEntitiesEnv = OpenEnum<typeof ListEntitiesEnv>;
+/**
+ * Current status of the subscription.
+ */
+declare const ListEntitiesStatus: {
+    readonly Active: "active";
+    readonly Scheduled: "scheduled";
+};
+/**
+ * Current status of the subscription.
+ */
+type ListEntitiesStatus = OpenEnum<typeof ListEntitiesStatus>;
+type ListEntitiesSubscription = {
+    /**
+     * The unique identifier of this subscription. If a subscription_id was provided at attach time, it is used; otherwise, falls back to the internal ID.
+     */
+    id: string;
+    plan?: Plan | undefined;
+    /**
+     * The unique identifier of the subscribed plan.
+     */
+    planId: string;
+    /**
+     * Whether the plan was automatically enabled for the customer.
+     */
+    autoEnable: boolean;
+    /**
+     * Whether this is an add-on plan rather than a base subscription.
+     */
+    addOn: boolean;
+    /**
+     * Current status of the subscription.
+     */
+    status: ListEntitiesStatus;
+    /**
+     * Whether the subscription has overdue payments.
+     */
+    pastDue: boolean;
+    /**
+     * Timestamp when the subscription was canceled, or null if not canceled.
+     */
+    canceledAt: number | null;
+    /**
+     * Timestamp when the subscription will expire, or null if no expiry set.
+     */
+    expiresAt: number | null;
+    /**
+     * Timestamp when the trial period ends, or null if not on trial.
+     */
+    trialEndsAt: number | null;
+    /**
+     * Timestamp when the subscription started.
+     */
+    startedAt: number;
+    /**
+     * Start timestamp of the current billing period.
+     */
+    currentPeriodStart: number | null;
+    /**
+     * End timestamp of the current billing period.
+     */
+    currentPeriodEnd: number | null;
+    /**
+     * Number of units of this subscription (for per-seat plans).
+     */
+    quantity: number;
+};
+type ListEntitiesPurchase = {
+    plan?: Plan | undefined;
+    /**
+     * The unique identifier of the purchased plan.
+     */
+    planId: string;
+    /**
+     * Timestamp when the purchase expires, or null for lifetime access.
+     */
+    expiresAt: number | null;
+    /**
+     * Timestamp when the purchase was made.
+     */
+    startedAt: number;
+    /**
+     * Number of units purchased.
+     */
+    quantity: number;
+};
+/**
+ * Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools.
+ */
+declare const ListEntitiesType: {
+    readonly Boolean: "boolean";
+    readonly Metered: "metered";
+    readonly CreditSystem: "credit_system";
+};
+/**
+ * Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools.
+ */
+type ListEntitiesType = OpenEnum<typeof ListEntitiesType>;
+type ListEntitiesCreditSchema = {
+    /**
+     * ID of the metered feature that draws from this credit system.
+     */
+    meteredFeatureId: string;
+    /**
+     * Credits consumed per unit of the metered feature.
+     */
+    creditCost: number;
+};
+/**
+ * Display names for the feature in billing UI and customer-facing components.
+ */
+type ListEntitiesDisplay = {
+    /**
+     * Singular form for UI display (e.g., 'API call', 'seat').
+     */
+    singular?: string | null | undefined;
+    /**
+     * Plural form for UI display (e.g., 'API calls', 'seats').
+     */
+    plural?: string | null | undefined;
+};
+/**
+ * The full feature object if expanded.
+ */
+type ListEntitiesFeature = {
+    /**
+     * The unique identifier for this feature, used in /check and /track calls.
+     */
+    id: string;
+    /**
+     * Human-readable name displayed in the dashboard and billing UI.
+     */
+    name: string;
+    /**
+     * Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools.
+     */
+    type: ListEntitiesType;
+    /**
+     * For metered features: true if usage resets periodically (API calls, credits), false if allocated persistently (seats, storage).
+     */
+    consumable: boolean;
+    /**
+     * Event names that trigger this feature's balance. Allows multiple features to respond to a single event.
+     */
+    eventNames?: Array<string> | undefined;
+    /**
+     * For credit_system features: maps metered features to their credit costs.
+     */
+    creditSchema?: Array<ListEntitiesCreditSchema> | undefined;
+    /**
+     * Display names for the feature in billing UI and customer-facing components.
+     */
+    display?: ListEntitiesDisplay | undefined;
+    /**
+     * Whether the feature is archived and hidden from the dashboard.
+     */
+    archived: boolean;
+};
+type ListEntitiesFlags = {
+    /**
+     * The unique identifier for this flag.
+     */
+    id: string;
+    /**
+     * The plan ID this flag originates from, or null for standalone flags.
+     */
+    planId: string | null;
+    /**
+     * Timestamp when this flag expires, or null for no expiration.
+     */
+    expiresAt: number | null;
+    /**
+     * The feature ID this flag is for.
+     */
+    featureId: string;
+    /**
+     * The full feature object if expanded.
+     */
+    feature?: ListEntitiesFeature | undefined;
+};
+type ListEntitiesSpendLimit = {
+    /**
+     * Optional feature ID this spend limit applies to.
+     */
+    featureId?: string | undefined;
+    /**
+     * Whether this spend limit is enabled.
+     */
+    enabled: boolean;
+    /**
+     * Maximum allowed overage spend for the target feature.
+     */
+    overageLimit?: number | undefined;
+};
+/**
+ * Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
+ */
+declare const ListEntitiesThresholdType: {
+    readonly Usage: "usage";
+    readonly UsagePercentage: "usage_percentage";
+    readonly Remaining: "remaining";
+    readonly RemainingPercentage: "remaining_percentage";
+};
+/**
+ * Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
+ */
+type ListEntitiesThresholdType = OpenEnum<typeof ListEntitiesThresholdType>;
+type ListEntitiesUsageAlert = {
+    /**
+     * The feature ID this alert applies to.
+     */
+    featureId?: string | undefined;
+    /**
+     * Whether this usage alert is enabled.
+     */
+    enabled: boolean;
+    /**
+     * The threshold value that triggers the alert. For usage or remaining, this is an absolute count. For usage_percentage or remaining_percentage, this is a percentage (0-100).
+     */
+    threshold: number;
+    /**
+     * Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
+     */
+    thresholdType: ListEntitiesThresholdType;
+    /**
+     * Optional user-defined label to distinguish multiple alerts on the same feature.
+     */
+    name?: string | undefined;
+};
+type ListEntitiesOverageAllowed = {
+    /**
+     * The feature ID this overage allowed control applies to.
+     */
+    featureId: string;
+    /**
+     * Whether overage is allowed for this feature.
+     */
+    enabled: boolean;
+};
+/**
+ * Billing controls for the entity.
+ */
+type ListEntitiesBillingControls = {
+    /**
+     * List of overage spend limits per feature.
+     */
+    spendLimits?: Array<ListEntitiesSpendLimit> | undefined;
+    /**
+     * List of usage alert configurations per feature.
+     */
+    usageAlerts?: Array<ListEntitiesUsageAlert> | undefined;
+    /**
+     * List of overage allowed controls per feature. When enabled, usage can exceed balance.
+     */
+    overageAllowed?: Array<ListEntitiesOverageAllowed> | undefined;
+};
+/**
+ * The billing processor that owns this invoice.
+ */
+declare const ListEntitiesProcessorType: {
+    readonly Stripe: "stripe";
+    readonly Revenuecat: "revenuecat";
+};
+/**
+ * The billing processor that owns this invoice.
+ */
+type ListEntitiesProcessorType = OpenEnum<typeof ListEntitiesProcessorType>;
+type ListEntitiesInvoice = {
+    /**
+     * Array of plan IDs included in this invoice
+     */
+    planIds: Array<string>;
+    /**
+     * The Stripe invoice ID
+     */
+    stripeId: string;
+    /**
+     * The billing processor that owns this invoice.
+     */
+    processorType: ListEntitiesProcessorType;
+    /**
+     * The status of the invoice
+     */
+    status: string;
+    /**
+     * The total amount of the invoice
+     */
+    total: number;
+    /**
+     * The currency code for the invoice
+     */
+    currency: string;
+    /**
+     * Timestamp when the invoice was created
+     */
+    createdAt: number;
+    /**
+     * URL to the Stripe-hosted invoice page
+     */
+    hostedInvoiceUrl?: string | null | undefined;
+};
+type ListEntitiesList = {
+    /**
+     * The unique identifier of the entity
+     */
+    id: string | null;
+    /**
+     * The name of the entity
+     */
+    name: string | null;
+    /**
+     * The customer ID this entity belongs to
+     */
+    customerId?: string | null | undefined;
+    /**
+     * The feature ID this entity belongs to
+     */
+    featureId?: string | null | undefined;
+    /**
+     * Unix timestamp when the entity was created
+     */
+    createdAt: number;
+    /**
+     * The environment (sandbox/live)
+     */
+    env: ListEntitiesEnv;
+    subscriptions: Array<ListEntitiesSubscription>;
+    purchases: Array<ListEntitiesPurchase>;
+    balances: {
+        [k: string]: Balance;
+    };
+    flags: {
+        [k: string]: ListEntitiesFlags;
+    };
+    /**
+     * Billing controls for the entity.
+     */
+    billingControls?: ListEntitiesBillingControls | undefined;
+    /**
+     * Invoices for this entity (only included when expand=invoices)
+     */
+    invoices?: Array<ListEntitiesInvoice> | undefined;
+};
+/**
+ * OK
+ */
+type ListEntitiesResponse = {
+    /**
+     * Array of items for current page
+     */
+    list: Array<ListEntitiesList>;
+    /**
+     * Whether more results exist after this page
+     */
+    hasMore: boolean;
+    /**
+     * Current offset position
+     */
+    offset: number;
+    /**
+     * Limit passed in the request
+     */
+    limit: number;
+    /**
+     * Total number of items returned in the current page
+     */
+    total: number;
+    /**
+     * Total number of entities available in the current organization and environment
+     */
+    totalCount: number;
+    /**
+     * Total number of entities matching the current filter before pagination is applied
+     */
+    totalFilteredCount: number;
+};
+
 /**
  * Filter events by time range
  */
@@ -8724,6 +9161,54 @@ type EventsListParams = {
      */
     customRange?: ListEventsCustomRange | undefined;
 };
+declare const ListEventsIntervalEnum: {
+    readonly OneOff: "one_off";
+    readonly Minute: "minute";
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+    readonly Quarter: "quarter";
+    readonly SemiAnnual: "semi_annual";
+    readonly Year: "year";
+};
+type ListEventsIntervalEnum = OpenEnum<typeof ListEventsIntervalEnum>;
+type ListEventsReset = {
+    /**
+     * The reset interval (hour, day, week, month, etc.) or 'multiple' if combined from different intervals.
+     */
+    interval: ListEventsIntervalEnum | string;
+    /**
+     * Number of intervals between resets (eg. 2 for bi-monthly).
+     */
+    intervalCount?: number | undefined;
+    /**
+     * Timestamp when the balance will next reset.
+     */
+    resetsAt: number | null;
+};
+type Deductions = {
+    /**
+     * ID of the underlying balance row that was deducted from (customer_entitlement or rollover).
+     */
+    balanceId: string;
+    /**
+     * The feature this balance belongs to.
+     */
+    featureId: string;
+    /**
+     * ID of the plan/product this balance belongs to. Null when the balance can't be attributed to a single plan (e.g. it spans multiple).
+     */
+    planId: string | null;
+    /**
+     * Reset configuration for the balance this deduction came from, or null if the balance doesn't reset.
+     */
+    reset: ListEventsReset | null;
+    /**
+     * Amount deducted from this balance. Positive when usage was consumed, negative when credit was restored (e.g. a refund via negative track value).
+     */
+    value: number;
+};
 type ListEventsList = {
     /**
      * Event ID (KSUID)
@@ -8751,6 +9236,10 @@ type ListEventsList = {
     properties: {
         [k: string]: any;
     };
+    /**
+     * Per-balance breakdown of what this event deducted. Null for events ingested before deductions were tracked; an empty array means the event was accepted but no balance moved.
+     */
+    deductions: Array<Deductions> | null;
 };
 /**
  * OK
@@ -13718,6 +14207,54 @@ type TrackParams = {
     } | undefined;
     lock?: TrackLock | undefined;
 };
+declare const TrackIntervalEnum2: {
+    readonly OneOff: "one_off";
+    readonly Minute: "minute";
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+    readonly Quarter: "quarter";
+    readonly SemiAnnual: "semi_annual";
+    readonly Year: "year";
+};
+type TrackIntervalEnum2 = OpenEnum<typeof TrackIntervalEnum2>;
+type TrackReset2 = {
+    /**
+     * The reset interval (hour, day, week, month, etc.) or 'multiple' if combined from different intervals.
+     */
+    interval: TrackIntervalEnum2 | string;
+    /**
+     * Number of intervals between resets (eg. 2 for bi-monthly).
+     */
+    intervalCount?: number | undefined;
+    /**
+     * Timestamp when the balance will next reset.
+     */
+    resetsAt: number | null;
+};
+type Deduction2 = {
+    /**
+     * ID of the underlying balance row that was deducted from (customer_entitlement or rollover).
+     */
+    balanceId: string;
+    /**
+     * The feature this balance belongs to.
+     */
+    featureId: string;
+    /**
+     * ID of the plan/product this balance belongs to. Null when the balance can't be attributed to a single plan (e.g. it spans multiple).
+     */
+    planId: string | null;
+    /**
+     * Reset configuration for the balance this deduction came from, or null if the balance doesn't reset.
+     */
+    reset: TrackReset2 | null;
+    /**
+     * Amount deducted from this balance. Positive when usage was consumed, negative when credit was restored (e.g. a refund via negative track value).
+     */
+    value: number;
+};
 /**
  * Accepted. Autumn is experiencing degraded service from a downstream provider, so the event was accepted for replay and will be tracked as soon as the service is restored.
  */
@@ -13748,6 +14285,58 @@ type TrackResponseBody2 = {
     balances?: {
         [k: string]: Balance | null;
     } | undefined;
+    /**
+     * Per-balance breakdown of what this event deducted. A single event can consume from multiple balance rows when credit systems or rollovers are involved; this surfaces each one so callers can build per-feature usage views without polling.
+     */
+    deductions?: Array<Deduction2> | undefined;
+};
+declare const TrackIntervalEnum1: {
+    readonly OneOff: "one_off";
+    readonly Minute: "minute";
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+    readonly Quarter: "quarter";
+    readonly SemiAnnual: "semi_annual";
+    readonly Year: "year";
+};
+type TrackIntervalEnum1 = OpenEnum<typeof TrackIntervalEnum1>;
+type TrackReset1 = {
+    /**
+     * The reset interval (hour, day, week, month, etc.) or 'multiple' if combined from different intervals.
+     */
+    interval: TrackIntervalEnum1 | string;
+    /**
+     * Number of intervals between resets (eg. 2 for bi-monthly).
+     */
+    intervalCount?: number | undefined;
+    /**
+     * Timestamp when the balance will next reset.
+     */
+    resetsAt: number | null;
+};
+type Deduction1 = {
+    /**
+     * ID of the underlying balance row that was deducted from (customer_entitlement or rollover).
+     */
+    balanceId: string;
+    /**
+     * The feature this balance belongs to.
+     */
+    featureId: string;
+    /**
+     * ID of the plan/product this balance belongs to. Null when the balance can't be attributed to a single plan (e.g. it spans multiple).
+     */
+    planId: string | null;
+    /**
+     * Reset configuration for the balance this deduction came from, or null if the balance doesn't reset.
+     */
+    reset: TrackReset1 | null;
+    /**
+     * Amount deducted from this balance. Positive when usage was consumed, negative when credit was restored (e.g. a refund via negative track value).
+     */
+    value: number;
 };
 /**
  * OK
@@ -13779,6 +14368,10 @@ type TrackResponseBody1 = {
     balances?: {
         [k: string]: Balance | null;
     } | undefined;
+    /**
+     * Per-balance breakdown of what this event deducted. A single event can consume from multiple balance rows when credit systems or rollovers are involved; this surfaces each one so callers can build per-feature usage views without polling.
+     */
+    deductions?: Array<Deduction1> | undefined;
 };
 type TrackResponse = TrackResponseBody1 | TrackResponseBody2;
 
@@ -15415,6 +16008,7 @@ type UpdatePlanParams = {
      * Miscellaneous plan-level configuration flags.
      */
     config?: UpdatePlanConfigRequest | undefined;
+    createInStripe?: boolean | undefined;
     version?: number | undefined;
     archived?: boolean | undefined;
     /**
@@ -16113,7 +16707,7 @@ declare class Billing extends ClientSDK {
      * @example
      * ```typescript
      * // Schedule a transition from a trial plan to a paid plan
-     * const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":1778177242707,"plans":[{"planId":"trial_plan"}]},{"startsAt":1779386842707,"plans":[{"planId":"pro_plan"}]}] });
+     * const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":1778684108513,"plans":[{"planId":"trial_plan"}]},{"startsAt":1779893708513,"plans":[{"planId":"pro_plan"}]}] });
      * ```
      *
      * @param customerId - The ID of the customer to create the schedule for.
@@ -16428,6 +17022,33 @@ declare class Entities extends ClientSDK {
      * @returns The entity object including its current subscriptions, purchases, and balances.
      */
     get(request: GetEntityParams, options?: RequestOptions): Promise<GetEntityResponse>;
+    /**
+     * Lists entities across the organization with pagination and optional filters.
+     *
+     * Use this to page through entities globally, including filtering by plans inherited from parent customers or attached directly to entities.
+     *
+     * @example
+     * ```typescript
+     * // List entities on a plan
+     * const response = await client.entities.list({ plans: [{"id":"pro_plan"}], limit: 10, offset: 0 });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Search entities by ID or name
+     * const response = await client.entities.list({ search: "workspace" });
+     * ```
+     *
+     * @param offset - Number of items to skip (optional)
+     * @param limit - Number of items to return. Default 10, max 1000. (optional)
+     * @param plans - Filter by plan ID and version. Returns entities with active subscriptions to this plan, including plans inherited from the parent customer. (optional)
+     * @param subscriptionStatus - Filter customer products used for entity hydration and plan matching. Defaults to active and scheduled. (optional)
+     * @param search - Search entities by id or name. (optional)
+     * @param processors - Filter by parent customer processor type (stripe, revenuecat, vercel). (optional)
+     *
+     * @returns A paginated list of entity objects including their current subscriptions, purchases, balances, and flags.
+     */
+    list(request?: ListEntitiesParams | undefined, options?: RequestOptions): Promise<ListEntitiesResponse>;
     /**
      * Updates an existing entity and returns the refreshed entity object.
      *