@usebillow/sdk 0.8.0 → 0.10.0

package/dist/index.d.ts

@@ -1,18 +1,18 @@
-import { f as SavedPaymentMethod, g as CreateHostedDomainInput, h as PayInvoiceInput } from './index.d-CKQAhQfJ.js';
-export { i as ContractAddSubscriptionItemInput, j as ContractApplySubscriptionCouponInput, k as ContractCancelSubscriptionInput, l as ContractChangeSubscriptionPlanInput, m as ContractCreateChargeInput, n as ContractCreateCustomerInput, o as ContractCreateMerchantInitiatedChargeInput, p as ContractCreatePortalSessionInput, q as ContractCreateProductInput, r as ContractCreateSubscriptionInput, s as ContractCreateWebhookEndpointInput, M as ContractMigrateSubscribersInput, R as ContractRefundChargeInput, t as ContractResolveRefundInput, U as ContractUpdateProductInput, u as ContractUpdateSubscriptionItemInput, v as ContractUpdateWebhookEndpointInput, H as HostedDomain, w as HostedDomainList, I as InvoicePaymentResult } from './index.d-CKQAhQfJ.js';
-import { C as ChargeStatus, P as PaymentMethodStatus, I as InvoiceStatus, R as RefundStatus, W as WebhookDeliveryStatus } from './billing-status-BZQN_gm7.js';
-export { a as CHARGE_STATUSES, b as INVOICE_STATUSES, c as PAYMENT_METHOD_STATUSES, d as REFUND_STATUSES, e as WEBHOOK_DELIVERY_STATUSES } from './billing-status-BZQN_gm7.js';
+import { f as SavedPaymentMethod, g as CreateHostedDomainInput, h as PayInvoiceInput } from './index.d-DSEYhV2c.js';
+export { i as ContractAddSubscriptionItemInput, j as ContractApplySubscriptionCouponInput, k as ContractCancelSubscriptionInput, l as ContractChangeSubscriptionPlanInput, m as ContractCreateChargeInput, n as ContractCreateCustomerInput, o as ContractCreateMerchantInitiatedChargeInput, p as ContractCreatePortalSessionInput, q as ContractCreateProductInput, r as ContractCreateSubscriptionInput, s as ContractCreateWebhookEndpointInput, M as ContractMigrateSubscribersInput, R as ContractRefundChargeInput, t as ContractResolveRefundInput, U as ContractUpdateProductInput, u as ContractUpdateSubscriptionItemInput, v as ContractUpdateWebhookEndpointInput, H as HostedDomain, w as HostedDomainList, I as InvoicePaymentResult } from './index.d-DSEYhV2c.js';
+import { C as ChargeStatus, P as PaymentMethodStatus, I as InvoiceStatus, R as RefundStatus, W as WebhookDeliveryStatus } from './billing-status-DZkB0VPK.js';
+export { a as CHARGE_STATUSES, b as INVOICE_STATUSES, c as PAYMENT_METHOD_STATUSES, d as REFUND_STATUSES, e as WEBHOOK_DELIVERY_STATUSES } from './billing-status-DZkB0VPK.js';
 import { SubscriptionStatus } from './status.js';
 export { ACTIVE_SUBSCRIPTION_STATUSES, NEVER_ACTIVATED_SUBSCRIPTION_STATUSES, SUBSCRIPTION_STATUSES, TERMINAL_SUBSCRIPTION_STATUSES, grantsAccess, isTerminal } from './status.js';
-import { c as TaxBehavior, d as Customer, U as UnappliedPaymentReason, e as CreateChargeInput, R as RequestOptions, f as Charge, g as CreateMerchantInitiatedChargeInput, I as IdempotentRequestOptions, h as CallOptions, C as CreateProductInput, i as UpdateProductInput, j as MigrationResult, k as CreateSubscriptionInput, B as BillowOptions, a as CreateCouponInput, l as Coupon, F as FeatureKind, M as MeterConfig, m as Feature, n as UpdateFeatureInput, o as UsageAlert, p as CreateUsageAlertInput, b as CheckResult, T as TrackResult, E as EntitlementView, A as AttachResult } from './billing-CgjcWmvb.js';
-export { q as ActivatedSubscriptionResult, r as BillingInterval, s as CouponDuration, t as CouponKind, u as CreateSubscriptionResult, v as EntitlementInput, w as MeterAggregation, x as MeterFilter, y as MeterRoundingMode, z as PendingSubscriptionCheckoutResult, D as PriceInput, P as Product, G as ProductEntitlement, H as ProductPrice, S as Subscription, J as SubscriptionDetail, K as SubscriptionItem, L as UpdatePriceInput, N as UsageAlertKind, O as UsageAlertMetric, Q as UsageModel, V as UsageTier } from './billing-CgjcWmvb.js';
-import { a as CreditThresholdLevel, e as CreditGrant, f as CreditTopUp, g as CreateCreditGrantInput, h as CreditGrantRequestResult, i as CreditPacks, j as CreateCreditPackInput, k as CreditPack, U as UpdateCreditPackInput, l as CreateCreditIncludedRuleInput, m as CreditIncludedRule, n as UpdateCreditIncludedRuleInput, o as CreateCreditTopUpInput, p as CreditTopUpRequestResult, q as CreditTopUpListParams, r as CreditBalance, s as CreditLedgerEntry, t as CreditUsageParams, u as CreditUsage } from './hosted-domains-BP91tg9P.js';
-export { v as CreditAccountStatus, w as CreditAllocationInterval, C as CreditGrantKind, x as CreditMoney, y as CreditPackBreakdown, z as CreditPackListItem, A as CreditTopUpStatus, B as CreditTransactionType, D as CreditUsageGroupBy, H as HostedDomainActivatedData, d as HostedDomainDisabledData, b as HostedDomainDnsFailingData, E as HostedDomainEventBase, c as HostedDomainReassignmentPendingData, F as HostedDomainStatus, G as HostedDomainStatusReason } from './hosted-domains-BP91tg9P.js';
+import { c as TaxBehavior, d as Customer, U as UnappliedPaymentReason, e as CreateChargeInput, R as RequestOptions, f as Charge, g as CreateMerchantInitiatedChargeInput, I as IdempotentRequestOptions, h as CallOptions, C as CreateProductInput, i as UpdateProductInput, j as MigrationResult, k as CreateSubscriptionInput, B as BillowOptions, a as CreateCouponInput, l as Coupon, F as FeatureKind, M as MeterConfig, m as Feature, n as UpdateFeatureInput, o as UsageAlert, p as CreateUsageAlertInput, b as CheckResult, T as TrackResult, E as EntitlementView, A as AttachResult } from './billing-Bs10EcjR.js';
+export { q as ActivatedSubscriptionResult, r as BillingInterval, s as CouponDuration, t as CouponKind, u as CreateSubscriptionResult, v as EntitlementInput, w as MeterAggregation, x as MeterFilter, y as MeterRoundingMode, z as PendingSubscriptionCheckoutResult, D as PriceInput, P as Product, G as ProductEntitlement, H as ProductPrice, S as Subscription, J as SubscriptionDetail, K as SubscriptionItem, L as UpdatePriceInput, N as UsageAlertKind, O as UsageAlertMetric, Q as UsageModel, V as UsageTier } from './billing-Bs10EcjR.js';
+import { a as CreditThresholdLevel, e as CreditGrant, f as CreditTopUp, g as CreditIncludedWindow, h as CreateCreditGrantInput, i as CreditGrantRequestResult, j as CreditPacks, k as CreateCreditPackInput, l as CreditPack, U as UpdateCreditPackInput, m as CreateCreditIncludedRuleInput, n as CreditIncludedRule, o as UpdateCreditIncludedRuleInput, p as CreditIncludedWindowListParams, q as CreateCreditTopUpInput, r as CreditTopUpRequestResult, s as CreditTopUpListParams, t as CreditBalance, u as CreditLedgerEntry, v as CreditUsageParams, w as CreditUsage } from './hosted-domains-DSs5Iw9U.js';
+export { x as CreditAccountStatus, y as CreditAllocationInterval, C as CreditGrantKind, z as CreditMoney, A as CreditPackBreakdown, B as CreditPackListItem, D as CreditTopUpStatus, E as CreditTransactionType, F as CreditUsageGroupBy, G as CreditWindowState, H as HostedDomainActivatedData, d as HostedDomainDisabledData, b as HostedDomainDnsFailingData, I as HostedDomainEventBase, c as HostedDomainReassignmentPendingData, J as HostedDomainStatus, K as HostedDomainStatusReason, L as IncludedCredits, M as IncludedPeriod } from './hosted-domains-DSs5Iw9U.js';
 import 'zod';
 
 /**
  * The machine-readable error codes billow returns on `BillowApiError.code`. Mirrored from
- * `@billow/core`'s `BILLOW_ERROR_CODES` (the server's source of truth) — the SDK carries no
+ * `@billow/core`'s `BILLOW_ERROR_CODES` (the server's source of truth) - the SDK carries no
  * runtime dependency on core, so `error-codes.test.ts` asserts this list stays in lockstep.
  *
  * `switch` on these for programmatic handling (e.g. surface `rate_limited` vs `validation_error`
@@ -98,7 +98,7 @@ interface ProviderCredentialSummary {
     currency: string;
     config: Record<string, unknown>;
 }
-/** The editable view of one credential set — secret values are never returned. */
+/** The editable view of one credential set - secret values are never returned. */
 interface CredentialSet {
     provider: string;
     currency: string;
@@ -134,7 +134,7 @@ interface BusinessProfile {
     logoUrl: string | null;
     /** Brand/accent color as `#RRGGBB` (PRD-11); null = billow's default accent. */
     brandColor: string | null;
-    /** Org-default tax treatment (Phase E) — every taxable price inherits this. */
+    /** Org-default tax treatment (Phase E) - every taxable price inherits this. */
     taxEnabled: boolean;
     /** Default rate in basis points (1% = 100 bps), e.g. 1400 for Egypt's 14% VAT. */
     taxRateBps: number;
@@ -234,7 +234,7 @@ interface Paginated<T> {
  * size), so it is correct under concurrent inserts/deletes; a list that grows at its head pages
  * by cursor instead ({@link CursorListPromise}). The caller's {@link CallOptions} (`signal` /
  * `timeoutMs`) apply to EVERY page
- * fetch — an abort stops the walk mid-stream; `timeoutMs` is per page.
+ * fetch - an abort stops the walk mid-stream; `timeoutMs` is per page.
  *
  * A returned value is ONE walk: page 1 is cached on it (so `await` then `for await` on the same
  * value fetch page 1 once), which means iterating the same value again later reuses that first
@@ -353,7 +353,7 @@ interface CustomerUsage {
     allowance: number | null;
     /** Gross units used this period (sum of positive events in the period). */
     used: number;
-    /** Units topped up this period — gross credit-backs (negative events). */
+    /** Units topped up this period - gross credit-backs (negative events). */
     added: number;
     /** Remaining = allowance + added − used; null = unlimited. May be negative (overage). */
     remaining: number | null;
@@ -431,7 +431,7 @@ interface SubscriptionListItem {
     scheduledChange: ScheduledSubscriptionChange | null;
     /** Renewals left before a limited-term subscription ends; null = open-ended. */
     remainingCycles: number | null;
-    /** Failed-renewal retries run so far (PRD-06 dunning) — 0 until a renewal fails. */
+    /** Failed-renewal retries run so far (PRD-06 dunning) - 0 until a renewal fails. */
     dunningAttempts: number;
     /** ISO-8601 time the next dunning retry is due; null when not in dunning (PRD-09). */
     nextDunningAt: string | null;
@@ -471,7 +471,7 @@ interface EmailTemplateSetting {
     defaultSubject: string;
     /** The variables the subject/message may reference (without braces). */
     variables: string[];
-    /** False for compliance-required templates (the receipt) — can't be disabled. */
+    /** False for compliance-required templates (the receipt) - can't be disabled. */
     canDisable: boolean;
     /** Subject override, or null when the default is in effect. */
     subject: string | null;
@@ -580,7 +580,7 @@ interface InvoiceListItem {
     currency: string;
     customerExternalId: string;
     subscriptionId: string | null;
-    /** What the invoice is for — the plan name (subscriptions) or first line item. */
+    /** What the invoice is for - the plan name (subscriptions) or first line item. */
     reason: string | null;
     periodStart: string | null;
     periodEnd: string | null;
@@ -599,6 +599,7 @@ interface InvoiceListParams extends ListParams {
 }
 interface InvoiceDetail {
     invoice: Invoice;
+    /** In the order the invoice lists them (as its PDF and receipt email do). */
     lineItems: InvoiceLineItem[];
 }
 /** How an offline payment was collected (ADR-0026). `other` is the escape hatch. */
@@ -632,7 +633,7 @@ interface MetricsOverview {
     to: string;
     /** Monthly recurring revenue (minor units). */
     mrr: number;
-    /** Annual recurring revenue (minor units) — `mrr × 12`. */
+    /** Annual recurring revenue (minor units) - `mrr × 12`. */
     arr: number;
     /** Cohort subscription churn over the window (0..1); null if none were active at its start. */
     churnRate: number | null;
@@ -696,7 +697,7 @@ interface Whoami {
     organizationId: string;
     organizationName: string | null;
     organizationSlug: string | null;
-    /** The billing workspace the API key scopes to — what every resource belongs to. */
+    /** The billing workspace the API key scopes to - what every resource belongs to. */
     projectId: string;
     projectName: string | null;
     projectSlug: string | null;
@@ -924,7 +925,7 @@ interface CreatePortalSessionInput {
     customerId: string;
     /** Which surface to land on; defaults to the self-serve portal. */
     flow?: PortalSessionFlow;
-    /** Product slug to subscribe to — required when `flow` is `checkout`. */
+    /** Product slug to subscribe to - required when `flow` is `checkout`. */
     productId?: string;
     /**
      * Where the surface returns the Customer when they finish or exit: an absolute `https` URL
@@ -942,7 +943,7 @@ interface PortalSession {
     id: string;
     url: string;
     flow: PortalSessionFlow;
-    /** ISO-8601 expiry — the session (and its URL) stop working after this. */
+    /** ISO-8601 expiry - the session (and its URL) stop working after this. */
     expiresAt: string;
 }
 /** The single-use entry exchange's input (`BillowPortal.exchange`). */
@@ -1014,7 +1015,7 @@ interface PortalPlanChange {
     subscription: PortalSubscriptionStatus;
     /** Upgrade only: the proration invoice raised for the prorated delta, when non-zero. */
     prorationInvoiceId?: string;
-    /** Upgrade only: the proration charge's status (`succeeded`/`failed`/`processing`/`pending`) —
+    /** Upgrade only: the proration charge's status (`succeeded`/`failed`/`processing`/`pending`) -
      *  present when an immediate charge was raised, so a client can surface an unresolved payment. */
     chargeStatus?: string;
 }
@@ -1110,6 +1111,7 @@ interface CustomerDataExport {
         createdAt: string;
         updatedAt: string;
     }>;
+    /** By invoice, each invoice's lines in the order it lists them. */
     invoiceLineItems: Array<{
         id: string;
         invoiceId: string;
@@ -1118,6 +1120,8 @@ interface CustomerDataExport {
         amount: number;
         quantity: number;
         currency: string;
+        /** Where the line sits on its invoice, from 0. */
+        position: number;
         createdAt: string;
         updatedAt: string;
     }>;
@@ -1186,6 +1190,8 @@ interface CustomerCreditsExport {
     reversals: CreditReversal[];
     /** Every quote made for the customer (even with no credit account), with its priced lines. */
     quotes: CreditQuote[];
+    /** Every Included Credit Window of the customer's subscriptions, oldest first. */
+    includedWindows: CreditIncludedWindow[];
     /** Every ledger transaction, in the order it was written, with its postings. */
     ledger: Array<{
         id: string;
@@ -1308,9 +1314,9 @@ interface WebhookEndpoint {
     createdAt: string;
     updatedAt: string;
 }
-/** Returned once at create/rotate — carries the plaintext signing secret. */
+/** Returned once at create/rotate - carries the plaintext signing secret. */
 interface WebhookEndpointWithSecret extends WebhookEndpoint {
-    /** The HMAC signing secret — shown exactly once. Store it now; it is never listed again. */
+    /** The HMAC signing secret - shown exactly once. Store it now; it is never listed again. */
     secret: string;
 }
 interface CreateWebhookEndpointInput {
@@ -1351,15 +1357,20 @@ declare class BillowApiError extends Error {
     readonly code: BillowErrorCode | (string & {});
     /** Structured error context from the server (e.g. per-field validation issues), when present. */
     readonly details?: unknown;
-    /** billow's per-request id (`x-request-id`) — quote it in a bug report to trace the server log. */
+    /** billow's per-request id (`x-request-id`) - quote it in a bug report to trace the server log. */
     readonly requestId?: string | undefined;
-    constructor(status: number, code: BillowErrorCode | (string & {}), message: string, details?: unknown, requestId?: string);
+    /**
+     * How many seconds to wait before trying again, from the response's `Retry-After` header (sent
+     * with a `429 rate_limited`); undefined when the response did not say.
+     */
+    readonly retryAfterSeconds?: number | undefined;
+    constructor(status: number, code: BillowErrorCode | (string & {}), message: string, details?: unknown, requestId?: string, retryAfterSeconds?: number);
 }
 /** Everything a request needs: the transport, the base URL, the bearer, and resilience knobs. */
 interface RequestContext {
     fetch: typeof fetch;
     baseUrl: string;
-    /** The bearer — a secret/publishable API key, or a portal-session token. */
+    /** The bearer - a secret/publishable API key, or a portal-session token. */
     bearer: string;
     timeoutMs: number;
     maxRetries: number;
@@ -1496,6 +1507,18 @@ declare function createCreditsResource(ctx: RequestContext): {
          */
         update: (ruleId: string, input: UpdateCreditIncludedRuleInput, options?: CallOptions) => Promise<CreditIncludedRule>;
     };
+    includedWindows: {
+        /**
+         * The Included Credit Windows of one or more subscriptions (`subscription`, an id or a list
+         * of up to 100), or of a customer (`customer`, by external id) - newest first: what each
+         * period Billow granted includes (the whole period, each month of it under a monthly rule,
+         * or a trial), how far it was issued, and its `state`. With `current: true`, only each
+         * subscription's latest window that has started - what it stands at now. Auto-paginating by
+         * cursor: `await` the first page, `for await (…)` every window, or `.listAll()` to collect
+         * them.
+         */
+        list: (params: CreditIncludedWindowListParams, options?: CallOptions) => CursorListPromise<CreditIncludedWindow>;
+    };
     topUps: {
         /**
          * Buy a Credit Pack for a customer: answers the top-up with `checkoutUrl`, the hosted
@@ -1709,7 +1732,7 @@ declare function createHostedDomainsResource(ctx: RequestContext): {
             hostnameUnicode: string;
             environment: "live";
             status: "failed" | "active" | "pending_verification" | "verified" | "disabled";
-            statusReason: "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | "suspended" | null;
+            statusReason: "suspended" | "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | null;
             isPrimary: boolean;
             records: {
                 type: "TXT" | "CNAME";
@@ -1766,7 +1789,7 @@ declare function createHostedDomainsResource(ctx: RequestContext): {
         hostnameUnicode: string;
         environment: "live";
         status: "failed" | "active" | "pending_verification" | "verified" | "disabled";
-        statusReason: "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | "suspended" | null;
+        statusReason: "suspended" | "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | null;
         isPrimary: boolean;
         records: {
             type: "TXT" | "CNAME";
@@ -1814,7 +1837,7 @@ declare function createHostedDomainsResource(ctx: RequestContext): {
         hostnameUnicode: string;
         environment: "live";
         status: "failed" | "active" | "pending_verification" | "verified" | "disabled";
-        statusReason: "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | "suspended" | null;
+        statusReason: "suspended" | "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | null;
         isPrimary: boolean;
         records: {
             type: "TXT" | "CNAME";
@@ -1863,7 +1886,7 @@ declare function createHostedDomainsResource(ctx: RequestContext): {
         hostnameUnicode: string;
         environment: "live";
         status: "failed" | "active" | "pending_verification" | "verified" | "disabled";
-        statusReason: "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | "suspended" | null;
+        statusReason: "suspended" | "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | null;
         isPrimary: boolean;
         records: {
             type: "TXT" | "CNAME";
@@ -1912,7 +1935,7 @@ declare function createHostedDomainsResource(ctx: RequestContext): {
         hostnameUnicode: string;
         environment: "live";
         status: "failed" | "active" | "pending_verification" | "verified" | "disabled";
-        statusReason: "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | "suspended" | null;
+        statusReason: "suspended" | "verification_expired" | "tls_unavailable" | "edge_blocked" | "dns_lost" | "reassigned" | "entitlement_lapsed" | null;
         isPrimary: boolean;
         records: {
             type: "TXT" | "CNAME";
@@ -1987,7 +2010,7 @@ declare function createInvoicesResource(ctx: RequestContext): {
     receipt: (id: string, options?: CallOptions) => Promise<ArrayBuffer>;
 };
 
-/** The marketplace Integration catalog — install / configure / toggle / uninstall (ADR-0008). */
+/** The marketplace Integration catalog - install / configure / toggle / uninstall (ADR-0008). */
 declare function createMarketplaceResource(ctx: RequestContext): {
     /** Every available Integration with this tenant's install state (no secret values). */
     catalog: (options?: CallOptions) => Promise<CatalogItem[]>;
@@ -2192,7 +2215,7 @@ declare function createProductsResource(ctx: RequestContext): {
 };
 
 /**
- * Organization settings (Phase D3, F) — the configurable dunning schedule, usage settlement grace,
+ * Organization settings (Phase D3, F) - the configurable dunning schedule, usage settlement grace,
  * the cross-currency reporting currency + FX-rate registry (ADR-0013), and transactional email
  * template overrides (PRD-10). All secret-key/server-side surface.
  */
@@ -2211,7 +2234,7 @@ declare function createSettingsResource(ctx: RequestContext): {
     };
     /**
      * Usage settlement grace (hours): defers *collection* of a boundary-adjacent priced
-     * calendar-meter renewal past the tz month boundary until late usage settles — the billed
+     * calendar-meter renewal past the tz month boundary until late usage settles - the billed
      * windows/amount are unchanged, only the invoice timing shifts. `0` disables it (the default);
      * a no-op for any subscription without a priced calendar meter. Cap 72h.
      */
@@ -2403,7 +2426,7 @@ declare function createSubscriptionsResource(ctx: RequestContext): {
         productSlug: string;
         productMetadata: Record<string, string>;
     } | null>;
-    /** Cancel — immediately, or at period end with `{ atPeriodEnd: true }`. */
+    /** Cancel - immediately, or at period end with `{ atPeriodEnd: true }`. */
     cancel: (id: string, opts?: {
         atPeriodEnd?: boolean;
     }) => Promise<{
@@ -2451,6 +2474,10 @@ declare function createSubscriptionsResource(ctx: RequestContext): {
         defaultPaymentMethodId: string | null;
         createdAt: string;
     }>;
+    /**
+     * Pause an active or trialing subscription: no renewals and no access until it is resumed.
+     * Refused while one of its invoices is still being collected.
+     */
     pause: (id: string) => Promise<{
         id: string;
         status: "active" | "incomplete" | "incomplete_expired" | "trialing" | "past_due" | "paused" | "canceled" | "unpaid";
@@ -2473,6 +2500,13 @@ declare function createSubscriptionsResource(ctx: RequestContext): {
         defaultPaymentMethodId: string | null;
         createdAt: string;
     }>;
+    /**
+     * Resume a paused subscription. Paused time is never billed: resumed before its paid period
+     * ends, it carries on and renews at `currentPeriodEnd`; resumed after, a fresh full period
+     * starts now and is charged at once like a renewal, with the ended period's usage (a decline
+     * returns it `past_due`). Usage recorded while paused is never billed. A paused trial resumes
+     * `trialing`. Duplicate calls are safe.
+     */
     resume: (id: string) => Promise<{
         id: string;
         status: "active" | "incomplete" | "incomplete_expired" | "trialing" | "past_due" | "paused" | "canceled" | "unpaid";
@@ -2501,7 +2535,7 @@ declare function createSubscriptionsResource(ctx: RequestContext): {
         couponId: string;
         cyclesRemaining: number | null;
     }>;
-    /** Change plan — immediate prorated upgrade, or downgrade scheduled for period end. `productId` accepts the product's id or slug. */
+    /** Change plan - immediate prorated upgrade, or downgrade scheduled for period end. `productId` accepts the product's id or slug. */
     changePlan: (id: string, productId: string) => Promise<{
         id: string;
         status: "active" | "incomplete" | "incomplete_expired" | "trialing" | "past_due" | "paused" | "canceled" | "unpaid";
@@ -2609,14 +2643,14 @@ declare function createWebhookEndpointsResource(ctx: RequestContext): {
     update: (id: string, input: UpdateWebhookEndpointInput) => Promise<WebhookEndpoint>;
     /** Delete an endpoint and its delivery history. */
     delete: (id: string) => Promise<void>;
-    /** Rotate the signing secret — the new plaintext is returned once. */
+    /** Rotate the signing secret - the new plaintext is returned once. */
     rotateSecret: (id: string) => Promise<WebhookEndpointWithSecret>;
     /** List delivery attempts for an endpoint (newest first). Auto-paginating. */
     deliveries: (id: string, params?: ListParams, options?: CallOptions) => ListPromise<WebhookDelivery>;
 };
 
 /**
- * billow client SDK — the "two lines of code" surface, mirroring Autumn's shape
+ * billow client SDK - the "two lines of code" surface, mirroring Autumn's shape
  * (CONTEXT/ARCHITECTURE §10). A thin typed wrapper over the billow REST API.
  *
  *   const billow = new Billow(process.env.BILLOW_SECRET_KEY!);
@@ -2655,7 +2689,7 @@ declare class Billow {
     /** Custom domains for the hosted customer portal (live keys, behind a rollout flag). */
     hostedDomains: ReturnType<typeof createHostedDomainsResource>;
     /**
-     * Organization settings (Phase D3, F) — the configurable dunning schedule, usage settlement grace,
+     * Organization settings (Phase D3, F) - the configurable dunning schedule, usage settlement grace,
      * and the cross-currency reporting currency + FX-rate registry (ADR-0013).
      */
     settings: ReturnType<typeof createSettingsResource>;
@@ -2663,12 +2697,12 @@ declare class Billow {
     coupons: {
         /** Define a coupon (a reusable discount template). */
         create: (input: CreateCouponInput) => Promise<Coupon>;
-        /** List coupons (secret key only — enumerates live promo codes). Auto-paginating. */
+        /** List coupons (secret key only - enumerates live promo codes). Auto-paginating. */
         list: (params?: ListParams, options?: CallOptions) => ListPromise<Coupon>;
         /** Deactivate a coupon (existing discounts keep running). */
         deactivate: (id: string) => Promise<Coupon>;
     };
-    /** Manage developer webhook endpoints — register, rotate secrets, inspect deliveries.
+    /** Manage developer webhook endpoints - register, rotate secrets, inspect deliveries.
      *  (To VERIFY incoming deliveries, import `constructEvent` from `@usebillow/sdk/webhooks`.) */
     features: {
         /** Define a feature (a boolean access gate, or a metered feature with a meter). */
@@ -2679,7 +2713,7 @@ declare class Billow {
             meter?: MeterConfig;
         }) => Promise<Feature>;
         /**
-         * Edit a feature in place: its `name`, and — for a metered feature — its `meter`
+         * Edit a feature in place: its `name`, and - for a metered feature - its `meter`
          * aggregation. The server refuses a meter change once usage has been recorded (it
          * would rewrite billed history), so set the meter right at create time or before you
          * start tracking. Returns the updated feature.
@@ -2713,7 +2747,7 @@ declare class Billow {
          * choose a credential set and `target` to probe one verify target (Paymob: a
          * method); pass `sampleToken` (SANDBOX ONLY) to run a functional sub-test.
          * This probe hits the provider's live API (mutates nothing here), so it takes a
-         * per-call {@link CallOptions} for a timeout / cancellation — `opts` is spread into
+         * per-call {@link CallOptions} for a timeout / cancellation - `opts` is spread into
          * the body, so `options` stays a separate trailing arg (never merged in).
          */
         verify: (provider: string, opts?: {
@@ -2733,7 +2767,7 @@ declare class Billow {
             }>;
         };
     };
-    /** The merchant's business identity — the seller block on documents and email from-name. */
+    /** The merchant's business identity - the seller block on documents and email from-name. */
     businessProfile: {
         /** The stored profile, or null if one was never saved. */
         get: (options?: CallOptions) => Promise<BusinessProfile | null>;
@@ -2742,11 +2776,11 @@ declare class Billow {
     };
     /**
      * Hosted customer surfaces (Phase G, ADR-0014). Mint a portal session for one of
-     * your signed-in users and redirect them to the returned `url` — the self-serve
+     * your signed-in users and redirect them to the returned `url` - the self-serve
      * portal, or a `checkout` hand-off for `productId`. The Customer's own calls go
      * through {@link BillowPortal}, constructed with the session token.
      */
-    /** Identity of this key's tenant — org, environment, configured currencies. */
+    /** Identity of this key's tenant - org, environment, configured currencies. */
     me(options?: CallOptions): Promise<Whoami>;
     /**
      * Global search (PRD-12) across customers, invoices, subscriptions, and charges
@@ -2756,7 +2790,7 @@ declare class Billow {
     search(q: string, limit?: number, options?: CallOptions): Promise<SearchResults>;
     /**
      * Gate access to a feature. `featureId` is the feature slug. Returns
-     * `{ allowed, balance }` — `balance` is `null` for unlimited/boolean features.
+     * `{ allowed, balance }` - `balance` is `null` for unlimited/boolean features.
      */
     check(input: {
         customerId: string;
@@ -2764,14 +2798,14 @@ declare class Billow {
     }, options?: CallOptions): Promise<CheckResult>;
     /**
      * Record usage of a metered feature (`value` defaults to 1; negative credits
-     * back). Pass `idempotencyKey` to make a retried call a no-op — which also makes the call
+     * back). Pass `idempotencyKey` to make a retried call a no-op - which also makes the call
      * safe to retry automatically when `maxRetries` is set.
      */
     track(input: {
         customerId: string;
         featureId: string;
         value?: number;
-        /** Arbitrary event properties — used by meter filters and property-based aggregations. */
+        /** Arbitrary event properties - used by meter filters and property-based aggregations. */
         properties?: Record<string, string | number>;
         idempotencyKey?: string;
         /**
@@ -2791,7 +2825,7 @@ declare class Billow {
 /**
  * The browser-safe client: construct it with a **publishable** key (`bl_<env>_pk_…`)
  * to read the public catalog from any origin (CORS-enabled). It exposes ONLY public,
- * project-scoped reads — products and their prices — so it is safe to ship in a
+ * project-scoped reads - products and their prices - so it is safe to ship in a
  * frontend bundle. Customer-scoped data (entitlements, checkout) is never reachable
  * with a publishable key; use the server handler or a portal session for that.
  */
@@ -2799,7 +2833,7 @@ declare class BillowPublishable {
     #private;
     constructor(publishableKey: string, opts?: BillowOptions);
     products: {
-        /** The active catalog — products and their prices, for a pricing table. */
+        /** The active catalog - products and their prices, for a pricing table. */
         list: (options?: CallOptions) => Promise<{
             id: string;
             slug: string;
@@ -2876,13 +2910,13 @@ declare class BillowPublishable {
 /**
  * The customer-surface client (Phase G, ADR-0014): construct it with a portal
  * session token (minted by your backend via `billow.portalSessions.create`) to act
- * as that one Customer. It exposes only their own data — no operator/secret-key
- * surface — so the token can be held by a hosted portal app safely.
+ * as that one Customer. It exposes only their own data - no operator/secret-key
+ * surface - so the token can be held by a hosted portal app safely.
  */
 declare class BillowPortal {
     #private;
     constructor(sessionToken: string, opts?: BillowOptions);
-    /** The portal shell: flow, return URL, merchant brand, and customer identity —
+    /** The portal shell: flow, return URL, merchant brand, and customer identity -
      *  the lightweight payload the hosting app frames every page with, and the
      *  validate-and-route check at login. */
     session(options?: CallOptions): Promise<PortalSessionInfo>;
@@ -2973,4 +3007,4 @@ declare class BillowPortal {
     };
 }
 
-export { AttachResult, BILLOW_ERROR_CODES, Billow, BillowApiError, type BillowErrorCode, BillowOptions, BillowPortal, BillowPublishable, type BusinessProfile, CallOptions, type CatalogItem, Charge, type ChargeListItem, type ChargeListParams, type ChargeSearchHit, ChargeStatus, CheckResult, type CheckoutMethodInfo, type ConfigField, type ConfigFieldOption, type ConfigFieldType, Coupon, CreateChargeInput, CreateCouponInput, CreateCreditGrantInput, CreateCreditIncludedRuleInput, CreateCreditPackInput, type CreateCreditQuoteInput, type CreateCreditReservationInput, CreateCreditTopUpInput, CreateHostedDomainInput, CreateMerchantInitiatedChargeInput, type CreatePortalSessionInput, CreateProductInput, CreateSubscriptionInput, CreateUsageAlertInput, type CreateWebhookEndpointInput, type CredentialSet, CreditBalance, type CreditDimensions, CreditGrant, CreditGrantRequestResult, CreditIncludedRule, CreditLedgerEntry, type CreditLineItem, CreditPack, CreditPacks, type CreditPricedLine, type CreditQuote, type CreditRateCard, type CreditRateCardItem, type CreditReservation, type CreditReservationListParams, type CreditReservationPage, type CreditReservationRequestResult, type CreditReservationStatus, type CreditReversal, type CreditReversalRequestResult, CreditThresholdLevel, CreditTopUp, CreditTopUpListParams, CreditTopUpRequestResult, CreditUsage, CreditUsageParams, type CursorListParams, type CursorListPromise, type CursorPaginated, Customer, type CustomerAnonymizationResult, type CustomerCreditsExport, type CustomerDataExport, type CustomerListItem, type CustomerListParams, type CustomerOverview, type CustomerSearchHit, type CustomerUsage, type CustomerUsageDetail, type EmailDeliveryListItem, type EmailDeliveryListParams, type EmailDeliveryStatus, type EmailTemplateSetting, EntitlementView, type ExchangeRate, type ExportJsonValue, type ExternalPaymentMethod, type ExternalPaymentResult, Feature, FeatureKind, IdempotentRequestOptions, type InboundWebhookListItem, type InboundWebhookListParams, type InboundWebhookOutcome, type IntegrationDefinition, type IntegrationKind, type IntegrationTier, type Invoice, type InvoiceDetail, type InvoiceLineItem, type InvoiceListItem, type InvoiceListParams, type InvoiceSearchHit, InvoiceStatus, type ListParams, type ListPromise, MeterConfig, type MetricsOverview, type MetricsParams, type MetricsRollup, MigrationResult, type OutboxEventListItem, type OutboxEventListParams, type OutboxEventStatus, type Paginated, PayInvoiceInput, type PaymentMethod, PaymentMethodStatus, type PaymentProviderDefinition, type PortalCardSetupResult, type PortalCheckout, type PortalPlanChange, type PortalSession, type PortalSessionExchange, type PortalSessionExchangeInput, type PortalSessionFlow, type PortalSessionInfo, type PortalSubscriptionStatus, type PortalView, type ProviderCredentialSummary, type ProviderVerifyResult, type ProviderVerifyTarget, type ProviderVerifyTargetResult, type PublishCreditRateCardInput, type RecordExternalPaymentInput, type Refund, type RefundChargeInput, type RefundRequestResult, type RefundReviewReason, RefundStatus, RequestOptions, type ResolveRefundInput, type ReverseCreditConsumptionInput, SavedPaymentMethod, type ScheduledSubscriptionChange, type SearchResults, type SubscriptionListItem, type SubscriptionListParams, type SubscriptionSearchHit, SubscriptionStatus, TaxBehavior, type TimeseriesInterval, type TimeseriesMetric, type TimeseriesParams, type TimeseriesPoint, type TimeseriesResult, TrackResult, UnappliedPaymentReason, type UpdateBusinessProfileInput, UpdateCreditIncludedRuleInput, UpdateCreditPackInput, type UpdateEmailTemplateInput, UpdateFeatureInput, UpdateProductInput, type UpdateWebhookEndpointInput, type UpsertCredentialsInput, UsageAlert, type WebhookDelivery, WebhookDeliveryStatus, type WebhookEndpoint, type WebhookEndpointWithSecret, type Whoami, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits };
+export { AttachResult, BILLOW_ERROR_CODES, Billow, BillowApiError, type BillowErrorCode, BillowOptions, BillowPortal, BillowPublishable, type BusinessProfile, CallOptions, type CatalogItem, Charge, type ChargeListItem, type ChargeListParams, type ChargeSearchHit, ChargeStatus, CheckResult, type CheckoutMethodInfo, type ConfigField, type ConfigFieldOption, type ConfigFieldType, Coupon, CreateChargeInput, CreateCouponInput, CreateCreditGrantInput, CreateCreditIncludedRuleInput, CreateCreditPackInput, type CreateCreditQuoteInput, type CreateCreditReservationInput, CreateCreditTopUpInput, CreateHostedDomainInput, CreateMerchantInitiatedChargeInput, type CreatePortalSessionInput, CreateProductInput, CreateSubscriptionInput, CreateUsageAlertInput, type CreateWebhookEndpointInput, type CredentialSet, CreditBalance, type CreditDimensions, CreditGrant, CreditGrantRequestResult, CreditIncludedRule, CreditIncludedWindow, CreditIncludedWindowListParams, CreditLedgerEntry, type CreditLineItem, CreditPack, CreditPacks, type CreditPricedLine, type CreditQuote, type CreditRateCard, type CreditRateCardItem, type CreditReservation, type CreditReservationListParams, type CreditReservationPage, type CreditReservationRequestResult, type CreditReservationStatus, type CreditReversal, type CreditReversalRequestResult, CreditThresholdLevel, CreditTopUp, CreditTopUpListParams, CreditTopUpRequestResult, CreditUsage, CreditUsageParams, type CursorListParams, type CursorListPromise, type CursorPaginated, Customer, type CustomerAnonymizationResult, type CustomerCreditsExport, type CustomerDataExport, type CustomerListItem, type CustomerListParams, type CustomerOverview, type CustomerSearchHit, type CustomerUsage, type CustomerUsageDetail, type EmailDeliveryListItem, type EmailDeliveryListParams, type EmailDeliveryStatus, type EmailTemplateSetting, EntitlementView, type ExchangeRate, type ExportJsonValue, type ExternalPaymentMethod, type ExternalPaymentResult, Feature, FeatureKind, IdempotentRequestOptions, type InboundWebhookListItem, type InboundWebhookListParams, type InboundWebhookOutcome, type IntegrationDefinition, type IntegrationKind, type IntegrationTier, type Invoice, type InvoiceDetail, type InvoiceLineItem, type InvoiceListItem, type InvoiceListParams, type InvoiceSearchHit, InvoiceStatus, type ListParams, type ListPromise, MeterConfig, type MetricsOverview, type MetricsParams, type MetricsRollup, MigrationResult, type OutboxEventListItem, type OutboxEventListParams, type OutboxEventStatus, type Paginated, PayInvoiceInput, type PaymentMethod, PaymentMethodStatus, type PaymentProviderDefinition, type PortalCardSetupResult, type PortalCheckout, type PortalPlanChange, type PortalSession, type PortalSessionExchange, type PortalSessionExchangeInput, type PortalSessionFlow, type PortalSessionInfo, type PortalSubscriptionStatus, type PortalView, type ProviderCredentialSummary, type ProviderVerifyResult, type ProviderVerifyTarget, type ProviderVerifyTargetResult, type PublishCreditRateCardInput, type RecordExternalPaymentInput, type Refund, type RefundChargeInput, type RefundRequestResult, type RefundReviewReason, RefundStatus, RequestOptions, type ResolveRefundInput, type ReverseCreditConsumptionInput, SavedPaymentMethod, type ScheduledSubscriptionChange, type SearchResults, type SubscriptionListItem, type SubscriptionListParams, type SubscriptionSearchHit, SubscriptionStatus, TaxBehavior, type TimeseriesInterval, type TimeseriesMetric, type TimeseriesParams, type TimeseriesPoint, type TimeseriesResult, TrackResult, UnappliedPaymentReason, type UpdateBusinessProfileInput, UpdateCreditIncludedRuleInput, UpdateCreditPackInput, type UpdateEmailTemplateInput, UpdateFeatureInput, UpdateProductInput, type UpdateWebhookEndpointInput, type UpsertCredentialsInput, UsageAlert, type WebhookDelivery, WebhookDeliveryStatus, type WebhookEndpoint, type WebhookEndpointWithSecret, type Whoami, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits };

package/dist/index.js

@@ -1,4 +1,4 @@
-export { BILLOW_ERROR_CODES, Billow, BillowApiError, BillowPortal, BillowPublishable, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits } from './chunk-J6JIZGWB.js';
-export { ACTIVE_SUBSCRIPTION_STATUSES, CHARGE_STATUSES, INVOICE_STATUSES, NEVER_ACTIVATED_SUBSCRIPTION_STATUSES, PAYMENT_METHOD_STATUSES, REFUND_STATUSES, SUBSCRIPTION_STATUSES, TERMINAL_SUBSCRIPTION_STATUSES, WEBHOOK_DELIVERY_STATUSES, grantsAccess, isTerminal } from './chunk-CCG4F5FK.js';
+export { BILLOW_ERROR_CODES, Billow, BillowApiError, BillowPortal, BillowPublishable, currencyExponent, formatMoney, isSecretField, toMajorUnits, toMinorUnits } from './chunk-XKN7ZRAR.js';
+export { ACTIVE_SUBSCRIPTION_STATUSES, CHARGE_STATUSES, INVOICE_STATUSES, NEVER_ACTIVATED_SUBSCRIPTION_STATUSES, PAYMENT_METHOD_STATUSES, REFUND_STATUSES, SUBSCRIPTION_STATUSES, TERMINAL_SUBSCRIPTION_STATUSES, WEBHOOK_DELIVERY_STATUSES, grantsAccess, isTerminal } from './chunk-47J7FYM5.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map