@openrails/billing-ui 0.233.2 → 0.234.0

package/dist/client/generated/wire.d.ts

@@ -133,6 +133,11 @@ export type CollectionPaymentMethod = {
     currency: string;
     payment_method_id: string;
 };
+export type CreateOrderParams = {
+    lines?: OrderLineParams[];
+    expected_total?: string;
+    payment?: OrderPayment;
+};
 export type CreatePaymentMethodParams = {
     psp_id?: string;
     payment_token?: string;
@@ -150,6 +155,12 @@ export type CurrencyUnits = {
     decimals: number;
     minor_decimals: number;
 };
+export type CustomerAccount = {
+    id: string;
+    balances: Balance[];
+    collection_payment_methods: CollectionPaymentMethod[];
+    unread_notifications: number;
+};
 export type CustomerAmount = {
     min_amount: string;
     max_amount: string;
@@ -198,10 +209,11 @@ export type Invoice = {
     tax: Record<string, unknown> | null;
     billing_contacts: InvoiceContact[];
     memo: string | null;
-    status: "draft" | "open" | "paid" | "past_due" | "uncollectible" | "voided";
+    status: "draft" | "open" | "paid" | "uncollectible" | "voided";
     collection_method: "charge_automatically" | "send_invoice";
     issued_at: string | null;
     due_at: string | null;
+    delinquent: boolean;
     paid_at: string | null;
     voided_at: string | null;
     uncollectible_at: string | null;
@@ -227,24 +239,10 @@ export type InvoiceLineItem = {
 };
 export type InvoicePayNow = {
     invoice: Invoice;
-    payment: InvoicePayment;
+    payment_id: string | null;
     operation: PaymentOperation;
     replayed: boolean;
 };
-export type InvoicePayment = {
-    id: string;
-    invoice_id: string;
-    currency: string;
-    amount: string;
-    status: "attempted" | "failed" | "settled";
-    payment_method_id: string | null;
-    rail: string | null;
-    transaction_id: string | null;
-    failure_code: string | null;
-    failure_reason: string | null;
-    attempted_at: string;
-    settled_at: string | null;
-};
 export type MarkNotificationsReadParams = {
     notification_ids?: string[];
 };
@@ -260,6 +258,8 @@ export type NextAction = {
     type: string;
     url: string | null;
     transactions: string[];
+    psp_id: string | null;
+    payload: Record<string, string> | null;
 };
 export type Notification = {
     id: string;
@@ -309,6 +309,76 @@ export type NotificationData = {
     payment_method?: string;
     user_email?: string;
 };
+export type Order = {
+    id: string;
+    customer_id: string;
+    origin: "customer" | "merchant";
+    status: "canceled" | "expired" | "open" | "paid" | "processing" | "requires_action";
+    number: string | null;
+    currency: string;
+    total: string;
+    lines: OrderLine[];
+    next_action: NextAction | null;
+    last_payment_error: PaymentFailure | null;
+    payment_options: OrderPaymentOption[];
+    payment_method_id: string | null;
+    payment_id: string | null;
+    expires_at: string;
+    paid_at: string | null;
+    canceled_at: string | null;
+    expired_at: string | null;
+    created_at: string;
+};
+export type OrderLine = {
+    id: string;
+    price_id: string;
+    product_id: string;
+    description: string;
+    quantity: number | null;
+    unit_amount: string;
+    amount: string;
+    ownership: "consumable" | "extend" | "unique";
+    billing_interval_hours: number | null;
+    access_duration_hours: number | null;
+    subscription_id: string | null;
+    product_access_id: string | null;
+};
+export type OrderLineParams = {
+    price_id?: string;
+    quantity?: number;
+};
+export type OrderLineRefusal = {
+    code: string;
+    message: string;
+    owned_by: string | null;
+    hint: string | null;
+};
+export type OrderPayment = {
+    payment_method_id?: string;
+};
+export type OrderPaymentOption = {
+    psp_id: string;
+    rail: string;
+    accepts: string[];
+};
+export type OrderPreview = {
+    currency: string;
+    total: string;
+    lines: OrderPreviewLine[];
+    payment_options: OrderPaymentOption[];
+};
+export type OrderPreviewLine = {
+    price_id: string;
+    product_id: string;
+    description: string;
+    quantity: number | null;
+    unit_amount: string;
+    amount: string;
+    ownership: "consumable" | "extend" | "unique";
+    billing_interval_hours: number | null;
+    access_duration_hours: number | null;
+    refusal: OrderLineRefusal | null;
+};
 export type PSPLinkState = {
     status: "error" | "linked" | "pending_manual_link" | "sync_disabled";
     ids: Record<string, string> | null;
@@ -340,6 +410,10 @@ export type PayCheckoutSessionParams = {
 export type PayInvoiceParams = {
     payment_method_id?: string;
 };
+export type PayOrderParams = {
+    payment?: OrderPayment;
+    expected_total?: string;
+};
 export type Payment = {
     id: string;
     kind: "charge" | "chargeback" | "dispute_reversal" | "refund";
@@ -349,7 +423,9 @@ export type Payment = {
     currency: string;
     customer_id: string;
     subscription_id: string | null;
-    price_id: string;
+    order_id: string | null;
+    invoice_id: string | null;
+    price_id: string | null;
     price: Price | null;
     product: ProductSummary | null;
     channel: "manual" | "rail";
@@ -425,6 +501,9 @@ export type PendingAction = {
 export type PortalResponse = {
     url: string;
 };
+export type PreviewOrderParams = {
+    lines?: OrderLineParams[];
+};
 export type Price = {
     customer_amount?: CustomerAmount;
     revision: number;
@@ -453,6 +532,7 @@ export type Product = {
     credit_grant?: CreditGrantSpec;
     tier_group: string | null;
     tier_rank: number;
+    ownership: "consumable" | "extend" | "unique" | null;
     archived: boolean;
     prices: Price[];
     created_at: string;
@@ -500,6 +580,16 @@ export type ReplacePaymentMethodCardParams = {
 export type RetrySubscriptionNowParams = {
     payment_method_id?: string;
 };
+export type ScheduledChange = {
+    price_id: string;
+    quantity: number | null;
+    effective_at: string;
+    source: "change" | "migration";
+    price_migration_id: string | null;
+    created_at: string;
+    price?: Price;
+    product?: ProductSummary;
+};
 export type SetSubscriptionPaymentMethodParams = {
     payment_method_id?: string;
 };
@@ -553,10 +643,7 @@ export type StripeEngineAuthentication = {
 export type Subscription = {
     collection_policy: string;
     recovery?: PaymentRecovery;
-    last_retry_at: string | null;
-    retry_attempts: number | null;
-    next_retry_at: string | null;
-    grace_ends_at: string | null;
+    dunning: SubscriptionDunning | null;
     deletion_scheduled_at?: string;
     payments?: Payment[];
     id: string;
@@ -568,7 +655,7 @@ export type Subscription = {
     rail: string;
     rail_subscription_id: string | null;
     status: "active" | "awaiting_method" | "canceled" | "past_due" | "pending" | "unverified";
-    scheduled_price_id?: string;
+    scheduled_change: ScheduledChange | null;
     payment_method_id: string | null;
     started_at: string;
     ended_at: string | null;
@@ -582,8 +669,6 @@ export type Subscription = {
     cancel_mode: string;
     price?: Price;
     product?: ProductSummary;
-    scheduled_price?: Price;
-    scheduled_product?: ProductSummary;
     card?: CardDetails;
     cancel_portal_url?: string;
     access?: SubscriptionAccess;
@@ -601,6 +686,14 @@ export type SubscriptionAccess = {
     starts_at: string;
     ends_at?: string;
 };
+export type SubscriptionDunning = {
+    attempts: number;
+    retries_left: number | null;
+    next_retry_at: string | null;
+    final_retry_at: string | null;
+    waiting_for_new_card: boolean;
+    last_failure_reason: "authentication_required" | "blocked_by_psp" | "call_issuer" | "card_not_supported" | "communication_error" | "currency_not_supported" | "do_not_honor" | "duplicate_transaction" | "expired_card" | "fraudulent" | "gateway_rejected" | "generic_decline" | "incorrect_address" | "incorrect_cvc" | "incorrect_number" | "incorrect_zip" | "insufficient_funds" | "invalid_account" | "invalid_expiry" | "invalid_pin" | "invalid_request" | "issuer_unavailable" | "lost_card" | "merchant_config" | "no_such_issuer" | "over_limit" | "pickup_card" | "processing_error" | "restricted_card" | "retry_later" | "security_violation" | "stolen_card" | "stop_recurring" | "transaction_not_allowed" | "try_again_later" | "unknown" | "update_cardholder_data" | null;
+};
 export type SubscriptionRetryNowResult = {
     subscription: Subscription;
     operation: PaymentOperation;
@@ -663,15 +756,12 @@ export type TokenQuote = {
     quoted_at: string;
     expires_at: string;
 };
-export type UnreadCount = {
-    unread_count: number;
-};
 export type Usage = {
     customer_id: string;
     currency: string;
     from: string;
     to: string;
-    group_by: "event_type" | "function" | "invoker" | "resource" | "tier";
+    group_by: "event_type" | "invoker" | "resource";
     rows: UsageRow[];
 };
 export type UsageRow = {

package/dist/client/index.d.ts

@@ -1,4 +1,4 @@
 export { CANCEL_REASON_MAX, CANCEL_REASON_MIN, createBillingClient, isWalletAction, isWalletRejection, RETRY_BUDGET_MS, signWalletAction, WalletRejectedError, type BillingClient, type BillingClientOptions, type CheckoutSourceOptions, type ListOptions, type SendSolanaTransaction, } from './client';
 export { BillingError, isBillingError, isServerError, readBillingError, toBillingError, type BillingErrorBody, } from './errors';
-export type { CardSetup, CardSummary, Currency, CurrencyScales, PaymentConfig, PublicConfig, CheckoutSessionLink, Invoice, ListPage, NewCard, NextAction, Page, Payment, PaymentAuthentication, PaymentMethod, PaymentOperation, PaymentRecovery, Price, Product, SolanaToken, Subscription, SubscriptionProduct, SubscriptionStatus, TierChange, TierChangePreview, } from './types';
+export type { Account, Balance, CardSetup, CardSummary, Currency, CurrencyScales, PaymentConfig, PublicConfig, CheckoutSessionLink, Invoice, ListPage, NewCard, NextAction, Page, Payment, PaymentAuthentication, PaymentMethod, PaymentOperation, PaymentRecovery, Price, Product, SolanaToken, Subscription, SubscriptionDunning, SubscriptionProduct, SubscriptionStatus, TierChange, TierChangePreview, } from './types';
 export { amountToDecimal, decimalToAmount, formatAmount, type Amount, } from '../lib/money';

package/dist/client/types.d.ts

@@ -109,6 +109,21 @@ export declare const nextActionSchema: z.ZodObject<{
     transactions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
 }, z.core.$strip>;
 export type NextAction = z.infer<typeof nextActionSchema>;
+/**
+ * A declined renewal being collected. `retries_left` and `final_retry_at`
+ * follow the merchant's dunning policy; both are null when the provider runs
+ * the retries. While `waiting_for_new_card`, nothing is charged until the card
+ * is replaced, and the subscription ends at `final_retry_at`.
+ */
+export declare const subscriptionDunningSchema: z.ZodObject<{
+    attempts: z.ZodNumber;
+    retries_left: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    next_retry_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    final_retry_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    waiting_for_new_card: z.ZodBoolean;
+    last_failure_reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type SubscriptionDunning = z.infer<typeof subscriptionDunningSchema>;
 export declare const subscriptionSchema: z.ZodObject<{
     id: z.ZodString;
     status: z.ZodString;
@@ -131,8 +146,14 @@ export declare const subscriptionSchema: z.ZodObject<{
         starts_at: z.ZodString;
         ends_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>>>;
-    grace_ends_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    next_retry_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    dunning: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        attempts: z.ZodNumber;
+        retries_left: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        next_retry_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        final_retry_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        waiting_for_new_card: z.ZodBoolean;
+        last_failure_reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>>;
     price: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         id: z.ZodString;
         key: z.ZodString;
@@ -166,38 +187,44 @@ export declare const subscriptionSchema: z.ZodObject<{
         tier_group: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         tier_rank: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     }, z.core.$strip>>>;
-    scheduled_price: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        id: z.ZodString;
-        key: z.ZodString;
-        revision: z.ZodOptional<z.ZodNumber>;
-        product_id: z.ZodString;
-        archived: z.ZodBoolean;
-        unit_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
-        customer_amount: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-            min_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
-            max_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+    scheduled_change: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        price_id: z.ZodString;
+        quantity: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        effective_at: z.ZodString;
+        source: z.ZodString;
+        price: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            key: z.ZodString;
+            revision: z.ZodOptional<z.ZodNumber>;
+            product_id: z.ZodString;
+            archived: z.ZodBoolean;
+            unit_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+            customer_amount: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                min_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+                max_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+            }, z.core.$strip>>>;
+            currency: z.ZodString;
+            access_duration_hours: z.ZodNullable<z.ZodNumber>;
+            billing_interval_hours: z.ZodNullable<z.ZodNumber>;
+            trial_unit_amount: z.ZodNullable<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>;
+            trial_duration_hours: z.ZodNullable<z.ZodNumber>;
+            psps: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodObject<{
+                status: z.ZodString;
+                ids: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+                sync_status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            }, z.core.$strip>>>>;
+            created_at: z.ZodString;
+            updated_at: z.ZodString;
+        }, z.core.$strip>>>;
+        product: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            key: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            revision: z.ZodOptional<z.ZodNumber>;
+            display_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            tier_group: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            tier_rank: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         }, z.core.$strip>>>;
-        currency: z.ZodString;
-        access_duration_hours: z.ZodNullable<z.ZodNumber>;
-        billing_interval_hours: z.ZodNullable<z.ZodNumber>;
-        trial_unit_amount: z.ZodNullable<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>;
-        trial_duration_hours: z.ZodNullable<z.ZodNumber>;
-        psps: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodObject<{
-            status: z.ZodString;
-            ids: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
-            sync_status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        }, z.core.$strip>>>>;
-        created_at: z.ZodString;
-        updated_at: z.ZodString;
-    }, z.core.$strip>>>;
-    scheduled_product: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        id: z.ZodString;
-        key: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        revision: z.ZodOptional<z.ZodNumber>;
-        display_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        tier_group: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        tier_rank: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     }, z.core.$strip>>>;
     card: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         brand: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -427,6 +454,37 @@ export declare const paymentSchema: z.ZodObject<{
     }, z.core.$strip>>>;
 }, z.core.$strip>;
 export type Payment = z.infer<typeof paymentSchema>;
+/** A customer's money in one currency. */
+export declare const balanceSchema: z.ZodObject<{
+    currency: z.ZodString;
+    billing_mode: z.ZodString;
+    balance_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+    held_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+    available_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+    owed_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+}, z.core.$strip>;
+export type Balance = z.infer<typeof balanceSchema>;
+/**
+ * The signed-in customer's summary (`GET /me`): money per currency, the card
+ * that pays each currency's invoices, and how many notices are unread.
+ */
+export declare const accountSchema: z.ZodObject<{
+    id: z.ZodString;
+    balances: z.ZodArray<z.ZodObject<{
+        currency: z.ZodString;
+        billing_mode: z.ZodString;
+        balance_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+        held_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+        available_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+        owed_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+    }, z.core.$strip>>;
+    collection_payment_methods: z.ZodArray<z.ZodObject<{
+        currency: z.ZodString;
+        payment_method_id: z.ZodString;
+    }, z.core.$strip>>;
+    unread_notifications: z.ZodNumber;
+}, z.core.$strip>;
+export type Account = z.infer<typeof accountSchema>;
 export declare const invoiceSchema: z.ZodObject<{
     id: z.ZodString;
     currency: z.ZodString;
@@ -439,6 +497,7 @@ export declare const invoiceSchema: z.ZodObject<{
     status: z.ZodString;
     issued_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     due_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    delinquent: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     paid_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     recovery: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         last_failure_reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;