@openrails/billing-ui 0.0.0-stage → 0.233.2

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

@@ -0,0 +1,682 @@
+export type ListPage<T> = {
+    data: T[];
+    next_cursor: string | null;
+};
+export type Balance = {
+    customer_id: string;
+    currency: string;
+    billing_mode: "arrears" | "prepaid";
+    balance_amount: string;
+    held_amount: string;
+    available_amount: string;
+    owed_amount: string;
+};
+export type BalanceTransaction = {
+    id: string;
+    customer_id: string;
+    currency: string;
+    type: "deposit" | "expire" | "owed_accrual" | "owed_payment" | "owed_repayment" | "owed_writeoff" | "reinstate" | "revoke" | "spend";
+    amount: string;
+    credit_grant_id: string | null;
+    invoker: string | null;
+    resource: string | null;
+    source: string;
+    source_id: string;
+    created_at: string;
+};
+export type BillingAddress = {
+    line1: string | null;
+    line2: string | null;
+    city: string | null;
+    state: string | null;
+    postal_code: string | null;
+    country: string | null;
+};
+export type BillingDetails = {
+    name: string | null;
+    email: string | null;
+    phone: string | null;
+    address: BillingAddress | null;
+};
+export type Capabilities = {
+    route_groups: Record<string, boolean> | null;
+    features: Record<string, boolean> | null;
+};
+export type CaptchaStatus = {
+    enabled: boolean;
+    required: boolean;
+    provider: string | null;
+    token_header: string;
+    client_script_url: string;
+};
+export type CardDetails = {
+    brand: string | null;
+    last4: string | null;
+    exp_month: number | null;
+    exp_year: number | null;
+};
+export type CardEntry = {
+    number?: string;
+    exp_month?: number;
+    exp_year?: number;
+    cvc?: string;
+};
+export type ChangeTierParams = {
+    price_id?: string;
+};
+export type CheckoutSession = {
+    id: string;
+    status: string;
+    merchant: CheckoutSessionMerchant;
+    plan: CheckoutSessionPlan;
+    line_items: CheckoutSessionLineItem[];
+    tax: string | null;
+    due_today: string | null;
+    options: CheckoutSessionOption[];
+    saved_methods: CheckoutSessionSavedMethod[];
+    next_action: NextAction | null;
+    operation: PaymentOperation | null;
+    payment_id: string | null;
+    subscription_id: string | null;
+    failure_message: string | null;
+    failure: PaymentFailure | null;
+    success_url: string | null;
+    embed_origin: string | null;
+    expires_at: string;
+};
+export type CheckoutSessionLineItem = {
+    label: string;
+    sublabel: string | null;
+    amount: string;
+};
+export type CheckoutSessionLink = {
+    id: string;
+    url: string | null;
+    expires_at: string;
+};
+export type CheckoutSessionMerchant = {
+    display_name: string;
+};
+export type CheckoutSessionOption = {
+    id: string;
+    psp_id: string;
+    rail: string;
+    mode: string;
+    driver: string;
+    public_config: Record<string, string> | null;
+};
+export type CheckoutSessionPayResult = {
+    status: string;
+    next_action: NextAction | null;
+    operation: PaymentOperation | null;
+    payment_id: string | null;
+    subscription_id: string | null;
+    failure_message: string | null;
+    failure: PaymentFailure | null;
+};
+export type CheckoutSessionPlan = {
+    auto_renew: boolean;
+    display_name: string;
+    unit_amount: string;
+    currency: string;
+    unit_decimals: number;
+    billing_interval_hours: number | null;
+    access_duration_hours: number | null;
+};
+export type CheckoutSessionSavedMethod = {
+    id: string;
+    option_id: string;
+    rail: string;
+    card: CardDetails | null;
+};
+export type CollectionPaymentMethod = {
+    currency: string;
+    payment_method_id: string;
+};
+export type CreatePaymentMethodParams = {
+    psp_id?: string;
+    payment_token?: string;
+    card?: CardEntry;
+    billing_details?: BillingDetails;
+};
+export type CreditGrantSpec = {
+    currency: string;
+    amount?: string;
+    from_payment?: boolean;
+    expires_after_days?: number;
+};
+export type CurrencyUnits = {
+    code: string;
+    decimals: number;
+    minor_decimals: number;
+};
+export type CustomerAmount = {
+    min_amount: string;
+    max_amount: string;
+};
+export type CustomerCancelSubscriptionParams = {
+    reason?: string;
+    signature?: string;
+};
+export type CustomerChangeTierParams = {
+    price_id?: string;
+    signature?: string;
+};
+export type CustomerEntitlement = {
+    entitlement: string;
+};
+export type CustomerNotificationLookup = {
+    notifications: Record<string, Notification | null> | null;
+};
+export type DriftField = {
+    field: string;
+    openrails_value: string;
+    remote_value: string;
+};
+export type Health = {
+    status: "ok" | "ready";
+};
+export type Invoice = {
+    id: string;
+    customer_id: string;
+    currency: string;
+    invoice_number: string | null;
+    period_starts_at: string;
+    period_ends_at: string;
+    usage_total: string;
+    deposits_total: string;
+    owed_accrued: string;
+    owed_paid: string;
+    closing_balance: string;
+    subtotal_amount: string;
+    total_amount: string;
+    amount_paid: string;
+    amount_due: string;
+    line_items: InvoiceLineItem[];
+    money_movements: Record<string, string> | null;
+    po_number: string | null;
+    tax: Record<string, unknown> | null;
+    billing_contacts: InvoiceContact[];
+    memo: string | null;
+    status: "draft" | "open" | "paid" | "past_due" | "uncollectible" | "voided";
+    collection_method: "charge_automatically" | "send_invoice";
+    issued_at: string | null;
+    due_at: string | null;
+    paid_at: string | null;
+    voided_at: string | null;
+    uncollectible_at: string | null;
+    finalized_at: string | null;
+    external_invoice_id: string | null;
+    collection_failure_count: number;
+    collection_failed_at: string | null;
+    next_collection_attempt_at: string | null;
+    last_collection_failure_code: string | null;
+    recovery: PaymentRecovery | null;
+    available_actions: ("mark_uncollectible" | "record_payment" | "retry_collection" | "void")[];
+    created_at: string;
+};
+export type InvoiceContact = {
+    name: string;
+    email: string;
+};
+export type InvoiceLineItem = {
+    event_type: string;
+    amount: string;
+    count: number;
+    dimensions: Record<string, number> | null;
+};
+export type InvoicePayNow = {
+    invoice: Invoice;
+    payment: InvoicePayment;
+    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[];
+};
+export type MintCheckoutSessionParams = {
+    price_id?: string;
+    price_key?: string;
+    product_key?: string;
+    amount?: string;
+    auto_renew?: boolean;
+    success_url?: string;
+};
+export type NextAction = {
+    type: string;
+    url: string | null;
+    transactions: string[];
+};
+export type Notification = {
+    id: string;
+    customer_id: string;
+    event_type: string;
+    data: NotificationData;
+    seen: boolean;
+    created_at: string;
+};
+export type NotificationData = {
+    reason?: string;
+    message?: string;
+    source?: string;
+    product_id?: string;
+    ended_at?: string;
+    currency?: string;
+    subscription_id?: string;
+    from_price_id?: string;
+    to_price_id?: string;
+    to_product_id?: string;
+    to_product_name?: string;
+    old_amount?: string;
+    new_amount?: string;
+    effective_at?: string;
+    period_starts_at?: string;
+    period_ends_at?: string;
+    downgrade_applied?: boolean;
+    new_product?: string;
+    overdue_amount?: string;
+    overdue_invoices?: number;
+    overdue_started_at?: string;
+    from_state?: string;
+    to_state?: string;
+    invoice_id?: string;
+    invoice_number?: string;
+    amount_due?: string;
+    due_at?: string;
+    failure_code?: string;
+    failure_reason?: string;
+    decline_outcome?: string;
+    next_attempt_at?: string;
+    rail?: string;
+    rail_subscription_id?: string;
+    transaction_id?: string;
+    amount?: string;
+    product_name?: string;
+    payment_method?: string;
+    user_email?: string;
+};
+export type PSPLinkState = {
+    status: "error" | "linked" | "pending_manual_link" | "sync_disabled";
+    ids: Record<string, string> | null;
+    lookup_key: string;
+    sync_status: "drifted" | "in_sync" | "missing" | "never_synced" | "sync_disabled" | "unknown";
+    drift: DriftField[];
+    message: string;
+};
+export type PSPPaymentConfig = {
+    psp_id: string;
+    key: string;
+    rail: string;
+    custodian: string;
+    display_name: string;
+    flow: string;
+    checkout: boolean;
+    config?: Record<string, string>;
+    status?: string;
+    retry_after?: number;
+};
+export type PayCheckoutSessionParams = {
+    option_id?: string;
+    payment_method_id?: string;
+    payment_token?: string;
+    card?: CardEntry;
+    billing_details?: BillingDetails;
+    token_symbol?: string;
+};
+export type PayInvoiceParams = {
+    payment_method_id?: string;
+};
+export type Payment = {
+    id: string;
+    kind: "charge" | "chargeback" | "dispute_reversal" | "refund";
+    status: "failed" | "partially_refunded" | "pending" | "refunded" | "succeeded";
+    amount: string;
+    amount_refunded: string;
+    currency: string;
+    customer_id: string;
+    subscription_id: string | null;
+    price_id: string;
+    price: Price | null;
+    product: ProductSummary | null;
+    channel: "manual" | "rail";
+    rail: string | null;
+    psp_id: string | null;
+    transaction_id: string;
+    card: CardDetails | null;
+    failure: PaymentFailure | null;
+    refunded_payment_id: string | null;
+    reason: string | null;
+    refunds: Payment[];
+    created_at: string;
+};
+export type PaymentConfig = {
+    psps: PSPPaymentConfig[];
+    solana: SolanaPaymentConfig | null;
+};
+export type PaymentFailure = {
+    reason: string;
+    message: string;
+    field?: string;
+};
+export type PaymentMethod = {
+    id: string;
+    customer_id: string;
+    rail: string;
+    psp_id: string | null;
+    card: CardDetails | null;
+    billing_details: BillingDetails | null;
+    health: PaymentMethodHealth;
+    subscriptions: PaymentMethodSubscription[];
+    collection_currencies: string[];
+    created_at: string;
+};
+export type PaymentMethodHealth = {
+    expiry_status: "expired" | "expiring_soon" | "valid" | null;
+    last_charged_at: string | null;
+    last_charge_outcome: "failed" | "succeeded" | null;
+    active: boolean;
+};
+export type PaymentMethodSetup = {
+    id: string;
+    status: string;
+    setup_intent_id?: string;
+    client_secret?: string;
+    payment_method_id?: string;
+};
+export type PaymentMethodSetupParams = {
+    psp_id?: string;
+    consent?: boolean;
+};
+export type PaymentMethodSubscription = {
+    id: string;
+    display_name: string;
+    created_at: string;
+};
+export type PaymentOperation = {
+    id: string;
+    status: string;
+};
+export type PaymentRecovery = {
+    last_failure_reason?: string;
+    retryable: boolean;
+    blocked_reason?: string;
+    operation?: PaymentOperation;
+};
+export type PendingAction = {
+    psp: string;
+    action: string;
+    hint: string;
+    patch_required: Record<string, Record<string, Record<string, string>>> | null;
+};
+export type PortalResponse = {
+    url: string;
+};
+export type Price = {
+    customer_amount?: CustomerAmount;
+    revision: number;
+    id: string;
+    key: string;
+    product_id: string;
+    archived: boolean;
+    unit_amount: string;
+    currency: string;
+    access_duration_hours: number | null;
+    billing_interval_hours: number | null;
+    trial_unit_amount: string | null;
+    trial_duration_hours: number | null;
+    psps: Record<string, PSPLinkState> | null;
+    pending_manual_actions: PendingAction[];
+    created_at: string;
+    updated_at: string;
+};
+export type Product = {
+    revision: number;
+    id: string;
+    key: string;
+    display_name: string;
+    description: string;
+    entitlements: string[];
+    credit_grant?: CreditGrantSpec;
+    tier_group: string | null;
+    tier_rank: number;
+    archived: boolean;
+    prices: Price[];
+    created_at: string;
+    updated_at: string;
+};
+export type ProductAccessGrant = {
+    id: string;
+    customer_id: string;
+    product_id: string;
+    product_key: string;
+    product_name: string;
+    source_type: "grace" | "grant" | "purchase" | "subscription";
+    source_id: string;
+    payment_id: string | null;
+    grant_reason: "comp" | "import" | "migration" | "staff" | null;
+    granted_by: string | null;
+    note: string | null;
+    status: string;
+    starts_at: string;
+    ends_at: string | null;
+    revoked_at: string | null;
+    revoke_reason: string | null;
+    created_at: string;
+    updated_at: string;
+};
+export type ProductSummary = {
+    id: string;
+    key: string;
+    display_name: string;
+    description: string;
+    tier_group: string | null;
+    tier_rank: number;
+    archived: boolean;
+};
+export type PublicConfig = {
+    capabilities: Capabilities;
+    currencies: CurrencyUnits[];
+    payment: PaymentConfig | null;
+};
+export type ReplacePaymentMethodCardParams = {
+    payment_token?: string;
+    card?: CardEntry;
+    billing_details?: BillingDetails;
+};
+export type RetrySubscriptionNowParams = {
+    payment_method_id?: string;
+};
+export type SetSubscriptionPaymentMethodParams = {
+    payment_method_id?: string;
+};
+export type SolanaPayGetResponse = {
+    label: string;
+    icon: string;
+};
+export type SolanaPayPostRequest = {
+    account?: string;
+};
+export type SolanaPayPostResponse = {
+    transaction: string;
+    message?: string;
+};
+export type SolanaPaymentConfig = {
+    network: string;
+    chain: string;
+    preferred_token: string;
+    tokens: SolanaPaymentToken[];
+};
+export type SolanaPaymentToken = {
+    symbol: string;
+    name: string;
+    mint: string;
+    decimals: number;
+    preferred: boolean;
+    recurring_eligible: boolean;
+};
+export type SpendLimits = {
+    currency: string;
+    invoker: string;
+    windows: SpendWindow[];
+};
+export type SpendWindow = {
+    scope: "invoker" | "invoker_tier" | "role";
+    key: string;
+    window_seconds: number;
+    limit: string;
+    currency: string;
+    used: string;
+    reserved: string;
+    remaining: string;
+    resets_at: string;
+};
+export type StripeEngineAuthentication = {
+    operation: PaymentOperation;
+    payment_intent_id?: string;
+    client_secret?: string;
+    provider_payment_method_id?: string;
+};
+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;
+    deletion_scheduled_at?: string;
+    payments?: Payment[];
+    id: string;
+    customer_id: string;
+    product_id: string;
+    price_id: string;
+    quantity: number;
+    psp_id: string;
+    rail: string;
+    rail_subscription_id: string | null;
+    status: "active" | "awaiting_method" | "canceled" | "past_due" | "pending" | "unverified";
+    scheduled_price_id?: string;
+    payment_method_id: string | null;
+    started_at: string;
+    ended_at: string | null;
+    current_period_starts_at: string | null;
+    current_period_ends_at: string | null;
+    canceled_at: string | null;
+    cancel_type: string | null;
+    cancel_feedback: string | null;
+    resumable: boolean;
+    cancel_scheduled: boolean;
+    cancel_mode: string;
+    price?: Price;
+    product?: ProductSummary;
+    scheduled_price?: Price;
+    scheduled_product?: ProductSummary;
+    card?: CardDetails;
+    cancel_portal_url?: string;
+    access?: SubscriptionAccess;
+    next_action: NextAction | null;
+    created_at: string;
+    updated_at: string;
+};
+export type SubscriptionAccess = {
+    kind: string;
+    product_id: string;
+    source_type?: string;
+    source_id?: string;
+    subscription_id?: string;
+    rail?: string;
+    starts_at: string;
+    ends_at?: string;
+};
+export type SubscriptionRetryNowResult = {
+    subscription: Subscription;
+    operation: PaymentOperation;
+    replayed: boolean;
+};
+export type SupportedTokensResponse = {
+    tokens: TokenInfo[];
+};
+export type TierChange = {
+    status: string;
+    action?: string;
+    effective?: string;
+    price_id: string;
+    rail: string;
+    subscription_id?: string;
+    next_action?: NextAction;
+    transaction_id: string | null;
+    message?: string;
+    delayed_start?: string;
+    currency?: string;
+    amount_due_now: string;
+    next_charge_amount: string;
+    next_charge_date?: string;
+    operation_id?: string;
+};
+export type TierChangePreview = {
+    action: string;
+    price_id: string;
+    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 TokenBalance = {
+    amount: string;
+    units: string;
+    sufficient: boolean;
+};
+export type TokenInfo = {
+    symbol: string;
+    name: string;
+    mint: string;
+    decimals: number;
+    price?: string;
+    preferred: boolean;
+    recurring_eligible: boolean;
+    quote?: TokenQuote;
+    balance?: TokenBalance;
+};
+export type TokenQuote = {
+    amount: string;
+    units: string;
+    token_price_usd: string;
+    fx_rate: string;
+    fx_currency: string;
+    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";
+    rows: UsageRow[];
+};
+export type UsageRow = {
+    key: string;
+    event_count: number;
+    amount: string;
+    dimensions: Record<string, number> | null;
+};

package/dist/client/index.d.ts

@@ -0,0 +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 { amountToDecimal, decimalToAmount, formatAmount, type Amount, } from '../lib/money';