@openrails/billing-ui 0.234.0 → 0.235.0

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

@@ -42,6 +42,13 @@ export type Capabilities = {
     route_groups: Record<string, boolean> | null;
     features: Record<string, boolean> | null;
 };
+export type CaptchaConfig = {
+    provider: string;
+    site_key: string;
+    script_url: string;
+    action: string;
+    token_header: string;
+};
 export type CaptchaStatus = {
     enabled: boolean;
     required: boolean;
@@ -61,9 +68,6 @@ export type CardEntry = {
     exp_year?: number;
     cvc?: string;
 };
-export type ChangeTierParams = {
-    price_id?: string;
-};
 export type CheckoutSession = {
     id: string;
     status: string;
@@ -129,10 +133,6 @@ export type CheckoutSessionSavedMethod = {
     rail: string;
     card: CardDetails | null;
 };
-export type CollectionPaymentMethod = {
-    currency: string;
-    payment_method_id: string;
-};
 export type CreateOrderParams = {
     lines?: OrderLineParams[];
     expected_total?: string;
@@ -158,7 +158,7 @@ export type CurrencyUnits = {
 export type CustomerAccount = {
     id: string;
     balances: Balance[];
-    collection_payment_methods: CollectionPaymentMethod[];
+    default_payment_methods: DefaultPaymentMethod[];
     unread_notifications: number;
 };
 export type CustomerAmount = {
@@ -169,16 +169,23 @@ export type CustomerCancelSubscriptionParams = {
     reason?: string;
     signature?: string;
 };
-export type CustomerChangeTierParams = {
-    price_id?: string;
+export type CustomerChangeSubscriptionParams = {
+    price_id?: string | null;
+    quantity?: number | null;
     signature?: string;
 };
 export type CustomerEntitlement = {
+    customer_id: string;
     entitlement: string;
+    quantity: number | null;
 };
 export type CustomerNotificationLookup = {
     notifications: Record<string, Notification | null> | null;
 };
+export type DefaultPaymentMethod = {
+    currency: string;
+    payment_method_id: string;
+};
 export type DriftField = {
     field: string;
     openrails_value: string;
@@ -243,8 +250,28 @@ export type InvoicePayNow = {
     operation: PaymentOperation;
     replayed: boolean;
 };
+export type Mandate = {
+    id: string;
+    customer_id: string;
+    payment_method_id: string | null;
+    psp_id: string;
+    kind: "card_on_file" | "recurring" | "unscheduled";
+    subscription_id: string | null;
+    currency: string | null;
+    status: "active" | "ended" | "requires_reconsent" | "revoked";
+    end_reason: "brand_changed" | "closed" | "customer_revoked" | "payment_method_removed" | "replaced" | "subscription_ended" | null;
+    ended_at: string | null;
+    card_brand: string | null;
+    initial_transaction_id: string | null;
+    network_transaction_id: string | null;
+    transaction_link_id: string | null;
+    storing_attempt_id: string | null;
+    accepted_at: string;
+    created_at: string;
+};
 export type MarkNotificationsReadParams = {
     notification_ids?: string[];
+    all?: boolean;
 };
 export type MintCheckoutSessionParams = {
     price_id?: string;
@@ -304,10 +331,14 @@ export type NotificationData = {
     rail?: string;
     rail_subscription_id?: string;
     transaction_id?: string;
+    quantity?: number;
     amount?: string;
     product_name?: string;
     payment_method?: string;
     user_email?: string;
+    payment_id?: string;
+    order_id?: string;
+    order_number?: string;
 };
 export type Order = {
     id: string;
@@ -425,6 +456,7 @@ export type Payment = {
     subscription_id: string | null;
     order_id: string | null;
     invoice_id: string | null;
+    quantity: number | null;
     price_id: string | null;
     price: Price | null;
     product: ProductSummary | null;
@@ -453,11 +485,16 @@ export type PaymentMethod = {
     customer_id: string;
     rail: string;
     psp_id: string | null;
+    status: "active" | "closed" | "removed" | "replaced";
+    replaced_by: string | null;
     card: CardDetails | null;
     billing_details: BillingDetails | null;
     health: PaymentMethodHealth;
+    contact_cardholder_at: string | null;
+    reusable: boolean;
+    mandates: Mandate[];
     subscriptions: PaymentMethodSubscription[];
-    collection_currencies: string[];
+    default_currencies: string[];
     created_at: string;
 };
 export type PaymentMethodHealth = {
@@ -504,9 +541,15 @@ export type PortalResponse = {
 export type PreviewOrderParams = {
     lines?: OrderLineParams[];
 };
+export type PreviewSubscriptionChangeParams = {
+    price_id?: string | null;
+    quantity?: number | null;
+};
 export type Price = {
     customer_amount?: CustomerAmount;
+    quantity: Quantity | null;
     revision: number;
+    version: number;
     id: string;
     key: string;
     product_id: string;
@@ -547,6 +590,7 @@ export type ProductAccessGrant = {
     source_type: "grace" | "grant" | "purchase" | "subscription";
     source_id: string;
     payment_id: string | null;
+    quantity: number | null;
     grant_reason: "comp" | "import" | "migration" | "staff" | null;
     granted_by: string | null;
     note: string | null;
@@ -570,7 +614,19 @@ export type ProductSummary = {
 export type PublicConfig = {
     capabilities: Capabilities;
     currencies: CurrencyUnits[];
+    rails: RailDefinition[];
     payment: PaymentConfig | null;
+    captcha: CaptchaConfig | null;
+};
+export type Quantity = {
+    min: number;
+    max: number;
+};
+export type RailDefinition = {
+    rail: "ccbill" | "nmi" | "solana" | "stripe";
+    display_name: string;
+    credential_keys: string[];
+    setting_keys: string[];
 };
 export type ReplacePaymentMethodCardParams = {
     payment_token?: string;
@@ -590,9 +646,12 @@ export type ScheduledChange = {
     price?: Price;
     product?: ProductSummary;
 };
-export type SetSubscriptionPaymentMethodParams = {
+export type SetDefaultPaymentMethodParams = {
     payment_method_id?: string;
 };
+export type SetSubscriptionPaymentMethodParams = {
+    payment_method_id?: string | null;
+};
 export type SolanaPayGetResponse = {
     label: string;
     icon: string;
@@ -645,18 +704,18 @@ export type Subscription = {
     recovery?: PaymentRecovery;
     dunning: SubscriptionDunning | null;
     deletion_scheduled_at?: string;
-    payments?: Payment[];
     id: string;
     customer_id: string;
     product_id: string;
     price_id: string;
-    quantity: number;
+    quantity: number | null;
     psp_id: string;
     rail: string;
     rail_subscription_id: string | null;
     status: "active" | "awaiting_method" | "canceled" | "past_due" | "pending" | "unverified";
     scheduled_change: ScheduledChange | null;
     payment_method_id: string | null;
+    mandate_id: string | null;
     started_at: string;
     ended_at: string | null;
     current_period_starts_at: string | null;
@@ -686,27 +745,11 @@ 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;
-    replayed: boolean;
-};
-export type SupportedTokensResponse = {
-    tokens: TokenInfo[];
-};
-export type TierChange = {
+export type SubscriptionChange = {
     status: string;
-    action?: string;
     effective?: string;
     price_id: string;
+    quantity: number | null;
     rail: string;
     subscription_id?: string;
     next_action?: NextAction;
@@ -719,18 +762,34 @@ export type TierChange = {
     next_charge_date?: string;
     operation_id?: string;
 };
-export type TierChangePreview = {
-    action: string;
+export type SubscriptionChangePreview = {
+    effective: string;
     price_id: string;
+    quantity: number | null;
     rail: string;
     currency: string;
     amount_due_now: string;
     next_charge_amount: string;
     next_charge_date?: string;
-    effective: string;
     is_estimate: boolean;
     message?: 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;
+    replayed: boolean;
+};
+export type SupportedTokensResponse = {
+    tokens: TokenInfo[];
+};
 export type TokenBalance = {
     amount: string;
     units: string;
@@ -756,6 +815,12 @@ export type TokenQuote = {
     quoted_at: string;
     expires_at: string;
 };
+export type UpdatePaymentMethodParams = {
+    exp_month?: number;
+    exp_year?: number;
+    billing_details?: BillingDetails;
+    reusable?: boolean;
+};
 export type Usage = {
     customer_id: string;
     currency: string;

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 { CANCEL_REASON_MAX, CANCEL_REASON_MIN, createBillingClient, isWalletAction, isWalletRejection, RETRY_BUDGET_MS, signWalletAction, WalletRejectedError, type BillingClient, type BillingClientOptions, type CheckoutSourceOptions, type ListOptions, type SendSolanaTransaction, type SubscriptionChangeInput, } from './client';
 export { BillingError, isBillingError, isServerError, readBillingError, toBillingError, type BillingErrorBody, } from './errors';
-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 type { Account, Balance, CaptchaConfig, CardSetup, CardSummary, Currency, CurrencyScales, PaymentConfig, PublicConfig, CheckoutSessionLink, Invoice, ListPage, NewCard, NextAction, Page, Payment, PaymentAuthentication, PaymentMethod, PaymentOperation, PaymentRecovery, Price, Product, SolanaToken, Subscription, SubscriptionDunning, SubscriptionProduct, SubscriptionStatus, SubscriptionChange, SubscriptionChangePreview, } from './types';
 export { amountToDecimal, decimalToAmount, formatAmount, type Amount, } from '../lib/money';

package/dist/client/types.d.ts

@@ -43,6 +43,7 @@ export declare const priceSchema: z.ZodObject<{
     id: z.ZodString;
     key: z.ZodString;
     revision: z.ZodOptional<z.ZodNumber>;
+    version: z.ZodOptional<z.ZodNumber>;
     product_id: z.ZodString;
     archived: z.ZodBoolean;
     unit_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
@@ -130,7 +131,9 @@ export declare const subscriptionSchema: z.ZodObject<{
     rail: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     product_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     price_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    quantity: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     psp_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    collection_policy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     payment_method_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     started_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     ended_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -158,6 +161,7 @@ export declare const subscriptionSchema: z.ZodObject<{
         id: z.ZodString;
         key: z.ZodString;
         revision: z.ZodOptional<z.ZodNumber>;
+        version: z.ZodOptional<z.ZodNumber>;
         product_id: z.ZodString;
         archived: z.ZodBoolean;
         unit_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
@@ -196,6 +200,7 @@ export declare const subscriptionSchema: z.ZodObject<{
             id: z.ZodString;
             key: z.ZodString;
             revision: z.ZodOptional<z.ZodNumber>;
+            version: z.ZodOptional<z.ZodNumber>;
             product_id: z.ZodString;
             archived: z.ZodBoolean;
             unit_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
@@ -301,7 +306,7 @@ export declare const paymentMethodSchema: z.ZodObject<{
         id: z.ZodString;
         display_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>>>>;
-    collection_currencies: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    default_currencies: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
     created_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export type PaymentMethod = z.infer<typeof paymentMethodSchema>;
@@ -326,6 +331,7 @@ export declare const productSchema: z.ZodObject<{
         id: z.ZodString;
         key: z.ZodString;
         revision: z.ZodOptional<z.ZodNumber>;
+        version: z.ZodOptional<z.ZodNumber>;
         product_id: z.ZodString;
         archived: z.ZodBoolean;
         unit_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
@@ -359,6 +365,7 @@ export declare const productSchema: z.ZodObject<{
         created_at: string;
         updated_at: string;
         revision?: number | undefined;
+        version?: number | undefined;
         customer_amount?: {
             min_amount: string;
             max_amount: string;
@@ -382,6 +389,7 @@ export declare const productSchema: z.ZodObject<{
         created_at: string;
         updated_at: string;
         revision?: number | undefined;
+        version?: number | undefined;
         customer_amount?: {
             min_amount: string;
             max_amount: string;
@@ -412,6 +420,7 @@ export declare const paymentSchema: z.ZodObject<{
         id: z.ZodString;
         key: z.ZodString;
         revision: z.ZodOptional<z.ZodNumber>;
+        version: z.ZodOptional<z.ZodNumber>;
         product_id: z.ZodString;
         archived: z.ZodBoolean;
         unit_amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
@@ -465,8 +474,8 @@ export declare const balanceSchema: z.ZodObject<{
 }, 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.
+ * The signed-in customer's summary (`GET /me`): money per currency, the
+ * default card of each currency, and how many notices are unread.
  */
 export declare const accountSchema: z.ZodObject<{
     id: z.ZodString;
@@ -478,7 +487,7 @@ export declare const accountSchema: z.ZodObject<{
         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<{
+    default_payment_methods: z.ZodArray<z.ZodObject<{
         currency: z.ZodString;
         payment_method_id: z.ZodString;
     }, z.core.$strip>>;
@@ -519,9 +528,9 @@ export declare const currencySchema: z.ZodObject<{
     minor_decimals: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
 export type Currency = z.infer<typeof currencySchema>;
-export declare const tierChangePreviewSchema: z.ZodObject<{
-    action: z.ZodString;
+export declare const subscriptionChangePreviewSchema: z.ZodObject<{
     price_id: z.ZodString;
+    quantity: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     rail: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     currency: z.ZodString;
     amount_due_now: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
@@ -531,12 +540,12 @@ export declare const tierChangePreviewSchema: z.ZodObject<{
     is_estimate: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     message: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
-export type TierChangePreview = z.infer<typeof tierChangePreviewSchema>;
-export declare const tierChangeSchema: z.ZodObject<{
+export type SubscriptionChangePreview = z.infer<typeof subscriptionChangePreviewSchema>;
+export declare const subscriptionChangeSchema: z.ZodObject<{
     status: z.ZodString;
-    action: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     effective: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     price_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    quantity: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     subscription_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     next_action: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         type: z.ZodString;
@@ -553,7 +562,7 @@ export declare const tierChangeSchema: z.ZodObject<{
     message: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     operation_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
-export type TierChange = z.infer<typeof tierChangeSchema>;
+export type SubscriptionChange = z.infer<typeof subscriptionChangeSchema>;
 export declare const solanaTokenSchema: z.ZodObject<{
     symbol: z.ZodString;
     name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -716,10 +725,24 @@ export declare const paymentConfigSchema: z.ZodObject<{
     }, z.core.$strip>>>;
 }, z.core.$strip>;
 export type PaymentConfig = z.infer<typeof paymentConfigSchema>;
+/**
+ * The challenge to solve when a request answers 403 `captcha_required`: load
+ * `script_url`, solve with `site_key` and `action`, and resend the request
+ * with the token in the `token_header` header.
+ */
+export declare const captchaConfigSchema: z.ZodObject<{
+    provider: z.ZodString;
+    site_key: z.ZodString;
+    script_url: z.ZodString;
+    action: z.ZodString;
+    token_header: z.ZodString;
+}, z.core.$strip>;
+export type CaptchaConfig = z.infer<typeof captchaConfigSchema>;
 /**
  * What a browser needs to know about the deployment and its merchant
- * (`GET /config`): the mount's capabilities, the currency registry and the
- * merchant's payment setup (null when the request resolves no merchant).
+ * (`GET /config`): the mount's capabilities, the currency registry, the
+ * merchant's payment setup (null when the request resolves no merchant) and
+ * the captcha (null when the deployment challenges nobody).
  */
 export declare const publicConfigSchema: z.ZodObject<{
     capabilities: z.ZodObject<{
@@ -802,6 +825,13 @@ export declare const publicConfigSchema: z.ZodObject<{
             }[] | null | undefined>>;
         }, z.core.$strip>>>;
     }, z.core.$strip>>>;
+    captcha: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        provider: z.ZodString;
+        site_key: z.ZodString;
+        script_url: z.ZodString;
+        action: z.ZodString;
+        token_header: z.ZodString;
+    }, z.core.$strip>>>;
 }, z.core.$strip>;
 export type PublicConfig = z.infer<typeof publicConfigSchema>;
 /** An in-page card setup; `payment_method_id` is set once the card is saved. */