@flintpay/node 3.0.0-beta.20261006210100 → 3.0.0-beta.20261006230000

package/declarations/CheckoutDeliverySelectionResultResponse.d.ts

@@ -49,4 +49,4 @@ import type { TaxBreakdown } from './TaxBreakdown.js';
 import type { ThemeConfig } from './ThemeConfig.js';
 import type { Tip } from './Tip.js';
 
-export type CheckoutDeliverySelectionResultResponse = { "data": (({ "audience": ("merchant") & ("merchant"); "checkout_session": CheckoutSession; "delivery_selection": DeliverySelection; "inventory_reservation"?: DeliveryInventoryReservationSummary; "order": Order; }) | ({ "audience": ("buyer") & ("buyer"); /** The checkout session after the change. Merchant-only fields, such as metadata and external_reference_id, are omitted. */ "checkout_session": { "active_payment_attempt"?: { /** RFC3339 timestamp. Format: date-time. */ "completed_at"?: string; "expected_outstanding_money": MoneyValue; /** Reason code for an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.code. Unmapped values are returned as attempt_failed. */ "failure_code"?: "card_declined" | "insufficient_funds" | "bank_account_closed" | "bank_account_not_found" | "bank_debit_not_authorized" | "bank_account_restricted" | "bank_debit_limit_exceeded" | "authentication_required" | "payment_blocked" | "expired_card" | "incorrect_cvc" | "processing_error" | "payment_method_unavailable" | "payment_method_declined" | "payment_not_completed" | "payment_action_expired" | "payment_method_temporarily_unavailable" | "payment_failed" | "authorization_canceled" | "coupon_reservation_failed" | "invalid_payment_source" | "inventory_unavailable" | "order_changed_before_payment" | "order_payment_customer_mismatch" | "payment_attempt_canceled" | "payment_attempt_expired" | "payment_authorization_canceled" | "payment_authorization_expired" | "payment_confirmation_rejected" | "payment_confirm_outcome_unknown" | "payment_link_capacity_claim_failed" | "payment_link_capacity_validation_failed" | "payment_method_activation_pending" | "payment_method_required" | "payment_option_not_allowed" | "payment_option_unavailable" | "payment_source_binding_failed" | "payment_source_conflict" | "payment_source_not_updatable" | "payment_source_ownership_mismatch" | "receipt_email_failed" | "resource_guarantee_failed" | "setup_action_unavailable" | "setup_canceled" | "setup_cancellation_outcome_unknown" | "setup_cancellation_pending" | "setup_confirmation_outcome_unknown" | "setup_hold_acquisition_failed" | "setup_preparation_outcome_unknown" | "setup_processing" | "setup_result_incomplete" | "setup_status_unknown" | "tip_allocation_sync_failed" | "zero_balance_hold_acquisition_failed" | "attempt_failed" | (string & {}); /** Explanation of an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.message. */ "failure_message"?: string; "gift_card_redemptions"?: Array<PaymentAttemptGiftCardRedemption>; /** Whether the attempt can continue through PayOrder with action: resume and this order_payment_attempt_id after any pending client action is complete. If false, check status before starting another payment; the attempt may still be in progress. */ "is_resumable": boolean; "mode": "payment" | "setup" | "settlement" | (string & {}); "order_payment_attempt_id": string; "payment_intents"?: Array<PaymentAttemptPaymentIntent>; "pending_actions"?: Array<PendingPaymentAction>; /** RFC3339 timestamp. Format: date-time. */ "started_at"?: string; "status": "processing" | "requires_action" | "requires_capture" | "partially_succeeded" | "requires_retry" | "finalizing" | "succeeded" | "failed" | "expired" | "canceled" | (string & {}); }; /** Contact the buyer entered in checkout before paying, saved with the session's checkout credential. Omitted until the buyer saves or clears a field. When a checkout session payment omits buyer_contact.email or buyer_contact.phone, Flint uses these values. Flint clears the contact 30 days after the session ends, and when a customer linked to the session is deleted. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared": boolean; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared": boolean; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: string; }; "checkout_session_id": string; /** The note supplied when the checkout session was closed. It is not shown to the buyer. */ "closed_reason"?: string; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "custom_text"?: CheckoutCustomTextWriteConfig; "customer"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id": string; "email": string; "name"?: string; "phone"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "customer_collection"?: CheckoutCustomerConfig; /** Contact and default addresses of the customer the checkout acts for: the customer the merchant created the session for, or the customer whose email the buyer confirmed in it. Present only on reads with the session's checkout credential while the session is open and acts for a customer. */ "customer_prefill"?: { /** The customer's default billing address. Omitted when the customer has none. */ "billing_address"?: { "city": string; /** ISO 3166-1 alpha-2 country code. minLength: 2. maxLength: 2. pattern: ^[A-Z]{2}$. Example: "US". */ "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; }; /** The customer's email. */ "email": string; /** The customer's default shipping address. Omitted when the customer has none. */ "shipping_address"?: { "city": string; /** ISO 3166-1 alpha-2 country code. minLength: 2. maxLength: 2. pattern: ^[A-Z]{2}$. Example: "US". */ "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; }; }; /** Immutable delivery method assignment captured when the checkout was created. */ "delivery_method_ids": Array<string>; /** Merchant-only immutable configuration lineage used to evaluate delivery quotes. */ "delivery_pinned_dependencies"?: Array<CheckoutDeliveryPinnedDependency>; /** Whether the order has at least one remaining quote-resolved fulfillment choice that must be selected before payment. */ "delivery_selection_required": boolean; "expiration"?: CheckoutExpirationConfig; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; /** Current fulfillment choices for Flint-owned pricing. Checkout credentials receive the fields available to buyers; merchant credentials also receive configuration lineage and diagnostics. External pricing reports requires_explicit_quote; reading this field does not request a delivery quote. Omitted when the session is not open, has no order, or Flint cannot read its delivery. */ "fulfillment"?: (({ "choice_groups": Array<DeliveryQuoteChoiceGroupResource>; "delivery_quote_id"?: string; "evaluation_status": "complete" | "incomplete" | "degraded" | "requires_explicit_quote" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Inputs the checkout's delivery methods need. Once the checkout has a delivery quote, these are the quote's input_requirements. Before that, they come from the methods alone and name no choice group: the fields in each method's quote_input_fields, and each recipient field a method requires. */ "input_requirements": Array<DeliveryInputRequirement>; "merchant_diagnostics": Array<DeliveryMerchantDiagnostic>; }) | ({ "buyer_reasons": Array<string>; "choice_groups": Array<BuyerDeliveryQuoteChoiceGroupResource>; "delivery_quote_id"?: string; "evaluation_status": "complete" | "incomplete" | "degraded" | "requires_explicit_quote" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Inputs the checkout's delivery methods need. Once the checkout has a delivery quote, these are the quote's input_requirements. Before that, they come from the methods alone and name no choice group: the fields in each method's quote_input_fields, and each recipient field a method requires. */ "input_requirements": Array<BuyerDeliveryInputRequirementResource>; }) | (object)); "invoice"?: (({ "collection_block_status"?: "none" | "inventory_blocked" | "resolved" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id"?: string; /** RFC3339 timestamp. Format: date-time. */ "due_at"?: string; "invoice_id": string; "invoice_number"?: string; "is_overdue": boolean; "order_id"?: string; "outstanding_money": MoneyValue; "paid_money": MoneyValue; "refund_status"?: "none" | "partially_refunded" | "refunded" | (string & {}); "refunded_money": MoneyValue; "status": "draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "invoice_id"?: string; "legal"?: LegalSettings; "merchant_id"?: string; /** How the buyer can reach the merchant for help: the support email, phone, and URL the merchant set. Present only on reads with the session's checkout credential, and only when the merchant set at least one of them. Show it where your checkout tells the buyer to contact the merchant, such as an expired or closed checkout, or your receipt. */ "merchant_support"?: { /** Support email address. Format: email. */ "email"?: string; /** Support phone number. */ "phone"?: string; /** Support page, as an absolute http or https URL. Format: uri. */ "url"?: string; }; "metadata"?: Record<string, string>; "order"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id"?: string; "fulfillment_status"?: "not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled" | "not_applicable" | "closed" | (string & {}); "order_id": string; "order_number"?: string; "payment_intent_ids"?: Array<string>; "payment_status": "unpaid" | "partially_paid" | "paid" | (string & {}); "pricing_amounts": PricingAmounts; "refund_status": "none" | "partially_refunded" | "refunded" | (string & {}); "settlement_amounts": SettlementAmounts; "status": "open" | "closed" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "order_id"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription" | (string & {}); "payment_collection"?: { "stripe"?: PaymentCollectionStripe; }; "payment_intent_ids"?: Array<string>; "payment_intents"?: Array<ExpandedPaymentIntentSummary>; "payment_link"?: (({ /** Format: int32. */ "completed_count": number; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "description"?: string; "name": string; "payment_link_id": string; "payment_link_type"?: "standard" | "donation" | "event" | (string & {}); "status": "active" | "inactive" | (string & {}); "subscription_plan_id"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; "url"?: string; }) | (null)); "payment_link_id"?: string; /** The card the buyer saved with this checkout's payment by giving a mobile phone number, and whether they confirmed it. Present only on reads with the session's checkout credential, after a payment that paid the order in full, or that was approved for the merchant to capture later, and saved a card this way. A checkout whose payment is approved stays open until the capture. */ "payment_method_save"?: { /** True while status is pending after the buyer confirmed the number by text, when the number alone can't save the card: the customer with the buyer's email existed before this payment, the buyer did not confirm that email in this checkout, and the number isn't already the customer's saved number with an active card saved with it. The buyer confirms the email with an emailed code to finish; the card is then saved with the number, which replaces the customer's saved number. */ "email_confirmation_required": boolean; /** When a pending save stops waiting: 24 hours after the payment succeeded or was approved. Format: date-time. */ "expires_at"?: string | null; /** Last two digits of the number the buyer gave, which a code is texted to. Set while status is pending. */ "phone_last_digits"?: string; "saved_with"?: "sms" | "email" | (string & {}); "status": "pending" | "saved" | "expired" | (string & {}); }; "payments"?: CheckoutPaymentConfig; /** Named conditions that affect checkout completion. Follow each problem's remediation action instead of reconstructing delivery lifecycle rules in the client. When Flint cannot read the checkout's delivery, the read still succeeds and reports delivery_selection_stale; its remediation says whether reading the session again can succeed, and its next action's reason_code names the error. */ "problems": Array<CheckoutProblemResource>; "promotion_config"?: CheckoutPromotionConfig; /** RFC3339 deadline for the restricted payment-attempt recovery window. Format: date-time. */ "recovery_expires_at"?: string | null; /** Whether this terminal session credential is temporarily restricted to recovering its owning payment attempt. */ "recovery_mode": boolean; /** Payment attempt that this checkout credential may recover while recovery_mode is true. */ "recovery_payment_attempt_id"?: string; "redirects"?: CheckoutRedirectsConfig; /** Whether checkout offers the buyer the option to save the card they type for faster checkout at this merchant. Present only on reads with the session's checkout credential. When true and save_payment_method_requires_verification is false, PayOrder accepts save_payment_method: true for one newly collected card. False when the merchant turned checkout.saved_payment_details off, customer accounts are merchant hosted, card is not an available payment option, the checkout collects an invoice, a subscription, or a return, or the checkout acts for no customer and Flint cannot email the buyer a verification code. */ "save_payment_method_offered"?: boolean; /** Whether the buyer can save the card they type by giving a US or Canadian mobile phone number with the payment, in save_payment_method_phone on POST /v1/orders/{order_id}/pay, and confirming it with a texted code after paying. Present only on reads with the session's checkout credential. True while Flint can send texts and either save_payment_method_requires_verification is true, so the number replaces confirming an email before paying, or the checkout acts for the customer whose email the buyer confirmed with this credential, so the number joins that customer's saved details once the buyer confirms it. */ "save_payment_method_phone_offered"?: boolean; /** Whether the buyer must confirm their email with a code before the checkout can save their card or use their saved cards. Present only on reads with the session's checkout credential. True when save_payment_method_offered is true and the checkout acts for no customer for this credential: the merchant created it without one, and either the buyer has not confirmed an email with this credential, or the customer whose email they confirmed has since changed that email or been deleted. A credential other than the one a confirmation returned, such as the hosted checkout link opened on another device, reads true. Send the code with POST /v1/checkout-sessions/{checkout_session_id}/customer-verifications. False while the checkout acts for a customer, and whenever save_payment_method_offered is false. */ "save_payment_method_requires_verification"?: boolean; "setup_collection"?: { "stripe"?: PaymentCollectionStripe; }; "status": "open" | "paid" | "partially_paid" | "expired" | "closed" | "invalidated" | (string & {}); "subscription_plan_id"?: string; /** Renewal terms a subscription checkout commits the buyer to. Frozen when the session's order was created, so later plan changes do not alter them. Absent when the checkout starts no subscription. */ "subscription_terms"?: { "billing_interval": "daily" | "weekly" | "monthly" | "yearly" | (string & {}); /** Number of billing intervals between recurring charges. Format: int32. */ "billing_interval_count": number; /** Minimum commitment in months, when the plan has one. Format: int32. */ "contract_term_months"?: number; /** Fee charged when the buyer cancels before the contract term ends, when the plan has one. */ "early_termination_fee_money"?: { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** Plan name shown to the buyer. */ "plan_name": string; /** Charge for one billing interval before tax: each line's unit price times its quantity, plus modifiers. */ "recurring_total_money": { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** One-time fee charged with the first payment, when the plan has one. */ "setup_fee_money"?: { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** Flint subscription plan ID the terms come from. */ "subscription_plan_id": string; /** Days before the first recurring charge, when the plan has a trial. Format: int32. */ "trial_period_days"?: number; }; "superseding_checkout_session_id"?: string; "surface": "hosted" | "embedded" | (string & {}); "tax"?: CheckoutTaxConfig; "terminal_reason"?: "payment_succeeded" | "payment_partially_succeeded" | "expired" | "api" | "order_mutated" | "superseded" | "invoice_paid_elsewhere" | "invoice_voided" | "invoice_uncollectible" | "invoice_balance_changed" | (string & {}); "theme"?: ThemeConfig; "tip"?: CheckoutTipConfig; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; "url"?: string; }; "delivery_selection": BuyerDeliverySelection; /** Omitted for checkout credentials, which cannot read the merchant's inventory reservation. Merchant credentials receive it on DeliverySelectionResult. */ "inventory_reservation"?: { /** RFC3339 timestamp. Format: date-time. */ "expires_at": string; "inventory_reservation_id": string; "owner_type": "delivery_selection" | "payment_attempt" | "order_balance_hold" | (string & {}); "required_next_action"?: "none" | "retry_payment" | "replace_selection" | "contact_merchant" | (string & {}); "status": "active" | "closed" | (string & {}); }; /** The order after the change. Merchant-only fields, such as external_reference_id and internal_note, are omitted. */ "order": { "active_payment_attempt"?: { /** RFC3339 timestamp. Format: date-time. */ "completed_at"?: string; "expected_outstanding_money": MoneyValue; /** Reason code for an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.code. Unmapped values are returned as attempt_failed. */ "failure_code"?: "card_declined" | "insufficient_funds" | "bank_account_closed" | "bank_account_not_found" | "bank_debit_not_authorized" | "bank_account_restricted" | "bank_debit_limit_exceeded" | "authentication_required" | "payment_blocked" | "expired_card" | "incorrect_cvc" | "processing_error" | "payment_method_unavailable" | "payment_method_declined" | "payment_not_completed" | "payment_action_expired" | "payment_method_temporarily_unavailable" | "payment_failed" | "authorization_canceled" | "coupon_reservation_failed" | "invalid_payment_source" | "inventory_unavailable" | "order_changed_before_payment" | "order_payment_customer_mismatch" | "payment_attempt_canceled" | "payment_attempt_expired" | "payment_authorization_canceled" | "payment_authorization_expired" | "payment_confirmation_rejected" | "payment_confirm_outcome_unknown" | "payment_link_capacity_claim_failed" | "payment_link_capacity_validation_failed" | "payment_method_activation_pending" | "payment_method_required" | "payment_option_not_allowed" | "payment_option_unavailable" | "payment_source_binding_failed" | "payment_source_conflict" | "payment_source_not_updatable" | "payment_source_ownership_mismatch" | "receipt_email_failed" | "resource_guarantee_failed" | "setup_action_unavailable" | "setup_canceled" | "setup_cancellation_outcome_unknown" | "setup_cancellation_pending" | "setup_confirmation_outcome_unknown" | "setup_hold_acquisition_failed" | "setup_preparation_outcome_unknown" | "setup_processing" | "setup_result_incomplete" | "setup_status_unknown" | "tip_allocation_sync_failed" | "zero_balance_hold_acquisition_failed" | "attempt_failed" | (string & {}); /** Explanation of an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.message. */ "failure_message"?: string; "gift_card_redemptions"?: Array<PaymentAttemptGiftCardRedemption>; /** Whether the attempt can continue through PayOrder with action: resume and this order_payment_attempt_id after any pending client action is complete. If false, check status before starting another payment; the attempt may still be in progress. */ "is_resumable": boolean; "mode": "payment" | "setup" | "settlement" | (string & {}); "order_payment_attempt_id": string; "payment_intents"?: Array<PaymentAttemptPaymentIntent>; "pending_actions"?: Array<PendingPaymentAction>; /** RFC3339 timestamp. Format: date-time. */ "started_at"?: string; "status": "processing" | "requires_action" | "requires_capture" | "partially_succeeded" | "requires_retry" | "finalizing" | "succeeded" | "failed" | "expired" | "canceled" | (string & {}); }; "applied_discounts"?: Array<AppliedDiscount>; "authorization_amounts"?: { "authorized_money": MoneyValue; "capturable_money": MoneyValue; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; }; /** What the buyer can do with the order, in this order: start_return, then resend_receipt. A buyer's read through a customer session on /v1/me, or in Flint's buyer account, lists both every time; a merchant read gets an empty list. A list of orders leaves start_return out, since only a read of one order checks return eligibility. start_return is due when the last open return window ends. Example: []. */ "buyer_actions": Array<BuyerAction>; /** Email and phone saved when payment started, from the pay request's buyer_contact or the paying checkout session's saved contact. It does not change the linked customer. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared": boolean; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared": boolean; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: string; }; "buyer_note"?: string; "charges"?: Array<OrderCharge>; "checkout_session_ids"?: Array<string>; /** The note supplied when the order was closed. It is not shown to the buyer. */ "closed_reason"?: string; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id": string; "email": string; "name"?: string; "phone"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "customer_id"?: string; /** The shipment or local-delivery destination committed for this order. Payment freezes this value; fulfillment recipient changes do not replace it. */ "delivery_destination"?: { "address": OrderDeliveryDestinationAddress; /** Delivery selection that controls this destination, when checkout collected it. */ "delivery_selection_id"?: string; /** Time payment froze this destination. Format: date-time. */ "frozen_at"?: string; "recipient"?: OrderDeliveryDestinationRecipient; "source": "delivery_selection" | "api" | "dashboard" | (string & {}); }; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; "fulfillment_status"?: "not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled" | "not_applicable" | "closed" | (string & {}); "fulfillments"?: Array<Fulfillment>; "gift_card_estimate"?: { "can_pay": boolean; "gift_card_money": MoneyValue; "gift_cards": Array<OrderGiftCardAllocation>; "is_reserved": boolean; /** Use an exact numeric string, not a floating-point number. Format: int64. */ "order_revision": string; "processor_money": MoneyValue; }; "gift_card_settlements"?: Array<OrderGiftCardSettlement>; "gift_card_tender_enabled"?: boolean; "gift_cards"?: Array<OrderGiftCardSelection>; "internal_note"?: string; "inventory_exception_status"?: "paid_inventory_failed" | "resolved" | (string & {}); /** The reservation holding stock for this order, when one exists. */ "inventory_reservation_id"?: string; /** Where this order's tracked demand is routed. Required before an order containing tracked variants can hold stock. */ "inventory_routing_source"?: { "inventory_allocation_policy_id"?: string; "inventory_allocation_policy_version_id"?: string; "location_id"?: string; "location_ids"?: Array<string>; "type": "fixed_location" | "policy" | "policy_version" | (string & {}); }; "line_items": Array<OrderLineItem>; "merchant_id"?: string; "metadata"?: Record<string, string>; "order_id": string; "order_number"?: string; /** Use an exact numeric string, not a floating-point number. Format: int64. */ "order_revision"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription" | (string & {}); "payment_collection"?: { "stripe"?: PaymentCollectionStripe; }; "payment_intent_ids"?: Array<string>; "payment_intents"?: Array<ExpandedPaymentIntentSummary>; "payment_status": "unpaid" | "partially_paid" | "paid" | (string & {}); "pricing_amounts": { "charge_money": MoneyValue; "discount_money": MoneyValue; "requested_tip_money": MoneyValue; "subtotal_money": MoneyValue; "tax_money": MoneyValue; "total_money": MoneyValue; }; "purchased_event"?: { "location"?: string; "name": string; /** RFC3339 timestamp. Format: date-time. */ "starts_at"?: string; "timezone"?: string; }; "refund_ids"?: Array<string>; "refund_status": "none" | "partially_refunded" | "refunded" | (string & {}); "requested_tip"?: RequestedTip; /** Value applied to this order from items the buyer returned, such as an exchange's replacement order. Included in settlement_amounts.paid_money. */ "return_credit_settlements"?: Array<OrderReturnCreditSettlement>; "settlement_amounts": { "balance_money": SignedMoney; "credit_money": MoneyValue; "net_collected_money": MoneyValue; "outstanding_money": MoneyValue; "paid_money": MoneyValue; "refunded_money": MoneyValue; "settled_tip_money": MoneyValue; }; "setup_collection"?: { "stripe"?: PaymentCollectionStripe; }; "status": "open" | "closed" | (string & {}); "subscription"?: (({ /** Format: int32. */ "billing_anchor_day": number; "cancel_at_period_end": boolean; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "current_period_end"?: string; "current_period_start"?: string; "customer_id": string; /** RFC3339 timestamp. Format: date-time. */ "next_billing_at"?: string; "status": "trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete" | (string & {}); "subscription_id": string; "subscription_plan_id": string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "subscription_id"?: string; "subscription_plan"?: (({ "billing_interval": "daily" | "weekly" | "monthly" | "yearly" | (string & {}); /** Format: int32. */ "billing_interval_count": number; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; /** ISO 4217 currency code. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; "description"?: string; "line_items"?: Array<SubscriptionPlanLineItem>; "name": string; "setup_fee_money"?: MoneyValue; "status": "active" | "archived" | (string & {}); "subscription_plan_id": string; /** Format: int32. */ "trial_period_days"?: number; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "subscription_plan_id"?: string; "tax": { /** Identifies which automatic tax behavior applies to this order. connected means the account's tax connection calculated it. standard marks an order calculated before automatic tax required a tax connection. */ "automatic_profile"?: "standard" | "connected" | (string & {}); "available_location_inputs"?: Array<string>; "enabled": boolean; "exemption"?: OrderTaxExemption; /** Normalized reason the most recent tax calculation could not complete. */ "failure_reason"?: "calculation_unavailable" | "location_unsupported" | "rate_unavailable" | (string & {}); "location"?: OrderTaxLocation; "mode": "automatic" | "external" | (string & {}); "status": "not_required" | "requires_location" | "calculated" | "exempt" | "incomplete" | (string & {}); "tax_breakdowns"?: Array<TaxBreakdown>; /** Explains why tax was charged or zero for this order. */ "taxability_reason": "standard_rated" | "not_taxable" | "customer_exempt" | "tax_disabled" | "no_jurisdiction" | "location_required" | (string & {}); }; "tips"?: Array<Tip>; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }; }) | (object)); "meta"?: ResponseMeta; "request_id"?: string; };
+export type CheckoutDeliverySelectionResultResponse = { "data": (({ "audience": ("merchant") & ("merchant"); "checkout_session": CheckoutSession; "delivery_selection": DeliverySelection; "inventory_reservation"?: DeliveryInventoryReservationSummary; "order": Order; }) | ({ "audience": ("buyer") & ("buyer"); /** The checkout session after the change. Merchant-only fields, such as metadata and external_reference_id, are omitted. */ "checkout_session": { "active_payment_attempt"?: { /** RFC3339 timestamp. Format: date-time. */ "completed_at"?: string; "expected_outstanding_money": MoneyValue; /** Reason code for an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.code. Unmapped values are returned as attempt_failed. */ "failure_code"?: "card_declined" | "insufficient_funds" | "bank_account_closed" | "bank_account_not_found" | "bank_debit_not_authorized" | "bank_account_restricted" | "bank_debit_limit_exceeded" | "authentication_required" | "payment_blocked" | "expired_card" | "incorrect_cvc" | "processing_error" | "payment_method_unavailable" | "payment_method_declined" | "payment_not_completed" | "payment_action_expired" | "payment_method_temporarily_unavailable" | "payment_failed" | "authorization_canceled" | "coupon_reservation_failed" | "invalid_payment_source" | "inventory_unavailable" | "order_changed_before_payment" | "order_payment_customer_mismatch" | "payment_attempt_canceled" | "payment_attempt_expired" | "payment_authorization_canceled" | "payment_authorization_expired" | "payment_confirmation_rejected" | "payment_confirm_outcome_unknown" | "payment_link_capacity_claim_failed" | "payment_link_capacity_validation_failed" | "payment_method_activation_pending" | "payment_method_required" | "payment_option_not_allowed" | "payment_option_unavailable" | "payment_source_binding_failed" | "payment_source_conflict" | "payment_source_not_updatable" | "payment_source_ownership_mismatch" | "receipt_email_failed" | "resource_guarantee_failed" | "setup_action_unavailable" | "setup_canceled" | "setup_cancellation_outcome_unknown" | "setup_cancellation_pending" | "setup_confirmation_outcome_unknown" | "setup_hold_acquisition_failed" | "setup_preparation_outcome_unknown" | "setup_processing" | "setup_result_incomplete" | "setup_status_unknown" | "tip_allocation_sync_failed" | "zero_balance_hold_acquisition_failed" | "attempt_failed" | (string & {}); /** Explanation of an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.message. */ "failure_message"?: string; "gift_card_redemptions"?: Array<PaymentAttemptGiftCardRedemption>; /** Whether the attempt can continue through PayOrder with action: resume and this order_payment_attempt_id after any pending client action is complete. If false, check status before starting another payment; the attempt may still be in progress. */ "is_resumable": boolean; "mode": "payment" | "setup" | "settlement" | (string & {}); "order_payment_attempt_id": string; "payment_intents"?: Array<PaymentAttemptPaymentIntent>; "pending_actions"?: Array<PendingPaymentAction>; /** RFC3339 timestamp. Format: date-time. */ "started_at"?: string; "status": "processing" | "requires_action" | "requires_capture" | "partially_succeeded" | "requires_retry" | "finalizing" | "succeeded" | "failed" | "expired" | "canceled" | (string & {}); }; /** Contact the buyer entered in checkout before paying, saved with the session's checkout credential. Omitted until the buyer saves or clears a field. When a checkout session payment omits buyer_contact.email or buyer_contact.phone, Flint uses these values. Flint clears the contact 30 days after the session ends, and when a customer linked to the session is deleted. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared": boolean; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared": boolean; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: string; }; "checkout_session_id": string; /** The note supplied when the checkout session was closed. It is not shown to the buyer. */ "closed_reason"?: string; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "custom_text"?: CheckoutCustomTextWriteConfig; "customer"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id": string; "email": string; "name"?: string; "phone"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "customer_collection"?: CheckoutCustomerConfig; /** Contact and default addresses of the customer the checkout acts for: the customer the merchant created the session for, or the customer whose email the buyer confirmed in it. Present only on reads with the session's checkout credential while the session is open and acts for a customer. */ "customer_prefill"?: { /** The customer's default billing address. Omitted when the customer has none. */ "billing_address"?: { "city": string; /** ISO 3166-1 alpha-2 country code. minLength: 2. maxLength: 2. pattern: ^[A-Z]{2}$. Example: "US". */ "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; }; /** The customer's email. */ "email": string; /** The customer's default shipping address. Omitted when the customer has none. */ "shipping_address"?: { "city": string; /** ISO 3166-1 alpha-2 country code. minLength: 2. maxLength: 2. pattern: ^[A-Z]{2}$. Example: "US". */ "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; }; }; /** Immutable delivery method assignment captured when the checkout was created. */ "delivery_method_ids": Array<string>; /** Merchant-only immutable configuration lineage used to evaluate delivery quotes. */ "delivery_pinned_dependencies"?: Array<CheckoutDeliveryPinnedDependency>; /** Whether the order has at least one remaining quote-resolved fulfillment choice that must be selected before payment. */ "delivery_selection_required": boolean; "expiration"?: CheckoutExpirationConfig; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; /** Current fulfillment choices for Flint-owned pricing. Checkout credentials receive the fields available to buyers; merchant credentials also receive configuration lineage and diagnostics. External pricing reports requires_explicit_quote; reading this field does not request a delivery quote. Omitted when the session is not open, has no order, or Flint cannot read its delivery. */ "fulfillment"?: (({ "choice_groups": Array<DeliveryQuoteChoiceGroupResource>; "delivery_quote_id"?: string; "evaluation_status": "complete" | "incomplete" | "degraded" | "requires_explicit_quote" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Inputs the checkout's delivery methods need. Once the checkout has a delivery quote, these are the quote's input_requirements. Before that, they come from the methods alone and name no choice group: the fields in each method's quote_input_fields, and each recipient field a method requires. */ "input_requirements": Array<DeliveryInputRequirement>; "merchant_diagnostics": Array<DeliveryMerchantDiagnostic>; }) | ({ "buyer_reasons": Array<string>; "choice_groups": Array<BuyerDeliveryQuoteChoiceGroupResource>; "delivery_quote_id"?: string; "evaluation_status": "complete" | "incomplete" | "degraded" | "requires_explicit_quote" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Inputs the checkout's delivery methods need. Once the checkout has a delivery quote, these are the quote's input_requirements. Before that, they come from the methods alone and name no choice group: the fields in each method's quote_input_fields, and each recipient field a method requires. */ "input_requirements": Array<BuyerDeliveryInputRequirementResource>; }) | (object)); "invoice"?: (({ "collection_block_status"?: "none" | "inventory_blocked" | "resolved" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id"?: string; /** RFC3339 timestamp. Format: date-time. */ "due_at"?: string; "invoice_id": string; "invoice_number"?: string; "is_overdue": boolean; "order_id"?: string; "outstanding_money": MoneyValue; "paid_money": MoneyValue; "refund_status"?: "none" | "partially_refunded" | "refunded" | (string & {}); "refunded_money": MoneyValue; "status": "draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "invoice_id"?: string; "legal"?: LegalSettings; "merchant_id"?: string; /** How the buyer can reach the merchant for help: the support email, phone, and URL the merchant set. Present only on reads with the session's checkout credential, and only when the merchant set at least one of them. Show it where your checkout tells the buyer to contact the merchant, such as an expired or closed checkout, or your receipt. */ "merchant_support"?: { /** Support email address. Format: email. */ "email"?: string; /** Support phone number. */ "phone"?: string; /** Support page, as an absolute http or https URL. Format: uri. */ "url"?: string; }; "metadata"?: Record<string, string>; "order"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id"?: string; "fulfillment_status"?: "not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled" | "not_applicable" | "closed" | (string & {}); "order_id": string; "order_number"?: string; "payment_intent_ids"?: Array<string>; "payment_status": "unpaid" | "partially_paid" | "paid" | (string & {}); "pricing_amounts": PricingAmounts; "refund_status": "none" | "partially_refunded" | "refunded" | (string & {}); "settlement_amounts": SettlementAmounts; "status": "open" | "closed" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "order_id"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription" | (string & {}); "payment_collection"?: { "stripe"?: PaymentCollectionStripe; }; "payment_intent_ids"?: Array<string>; "payment_intents"?: Array<ExpandedPaymentIntentSummary>; "payment_link"?: (({ /** Format: int32. */ "completed_count": number; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "description"?: string; "name": string; "payment_link_id": string; "payment_link_type"?: "standard" | "donation" | "event" | (string & {}); "status": "active" | "inactive" | (string & {}); "subscription_plan_id"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; "url"?: string; }) | (null)); "payment_link_id"?: string; /** The card the buyer saved with this checkout's payment by giving a mobile phone number, and whether they confirmed it. Present only on reads with the session's checkout credential, after a payment that paid the order in full, or that was approved for the merchant to capture later, and saved a card this way. A checkout whose payment is approved stays open until the capture. */ "payment_method_save"?: { /** True while status is pending after the buyer confirmed the number by text, when the number alone can't save the card: the customer with the buyer's email existed before this payment, the buyer did not confirm that email in this checkout, and the number isn't already the customer's saved number with an active card saved with it. The buyer confirms the email with an emailed code to finish; the card is then saved with the number, which replaces the customer's saved number. */ "email_confirmation_required": boolean; /** When a pending save stops waiting: 24 hours after the payment succeeded or was approved. Format: date-time. */ "expires_at"?: string | null; /** Last two digits of the number the buyer gave, which a code is texted to. Set while status is pending. */ "phone_last_digits"?: string; "saved_with"?: "sms" | "email" | (string & {}); "status": "pending" | "saved" | "expired" | (string & {}); }; "payments"?: CheckoutPaymentConfig; /** Named conditions that affect checkout completion. Follow each problem's remediation action instead of reconstructing delivery lifecycle rules in the client. When Flint cannot read the checkout's delivery, the read still succeeds and reports delivery_selection_stale; its remediation says whether reading the session again can succeed, and its next action's reason_code names the error. */ "problems": Array<CheckoutProblemResource>; "promotion_config"?: CheckoutPromotionConfig; /** RFC3339 deadline for the restricted payment-attempt recovery window. Format: date-time. */ "recovery_expires_at"?: string | null; /** Whether this terminal session credential is temporarily restricted to recovering its owning payment attempt. */ "recovery_mode": boolean; /** Payment attempt that this checkout credential may recover while recovery_mode is true. */ "recovery_payment_attempt_id"?: string; "redirects"?: CheckoutRedirectsConfig; /** Whether checkout offers the buyer the option to save the card they type for faster checkout at this merchant. Present only on reads with the session's checkout credential. When true and save_payment_method_requires_verification is false, PayOrder accepts save_payment_method: true for one newly collected card. False when the merchant turned checkout.saved_payment_details off, customer accounts are merchant hosted, card is not an available payment option, the checkout collects an invoice, a subscription, or a return, or the checkout acts for no customer and Flint cannot email the buyer a verification code. */ "save_payment_method_offered"?: boolean; /** Whether the buyer can save the card they type by giving a US or Canadian mobile phone number with the payment, in save_payment_method_phone on POST /v1/orders/{order_id}/pay, and confirming it with a texted code after paying. Present only on reads with the session's checkout credential. True while Flint can send texts and either save_payment_method_requires_verification is true, so the number replaces confirming an email before paying, or the checkout acts for the customer whose email the buyer confirmed with this credential, so the number joins that customer's saved details once the buyer confirms it. */ "save_payment_method_phone_offered"?: boolean; /** Whether the buyer must confirm their email with a code before the checkout can save their card or use their saved cards. Present only on reads with the session's checkout credential. True when save_payment_method_offered is true and the checkout acts for no customer for this credential: the merchant created it without one, and either the buyer has not confirmed an email with this credential, or the customer whose email they confirmed has since changed that email or been deleted. A credential other than the one a confirmation returned, such as the hosted checkout link opened on another device, reads true. Send the code with POST /v1/checkout-sessions/{checkout_session_id}/customer-verifications. False while the checkout acts for a customer, and whenever save_payment_method_offered is false. */ "save_payment_method_requires_verification"?: boolean; "setup_collection"?: { "stripe"?: PaymentCollectionStripe; }; "status": "open" | "paid" | "partially_paid" | "expired" | "closed" | "invalidated" | (string & {}); "subscription_plan_id"?: string; /** Renewal terms a subscription checkout commits the buyer to. Frozen when the session's order was created, so later plan changes do not alter them. Absent when the checkout starts no subscription. */ "subscription_terms"?: { "billing_interval": "daily" | "weekly" | "monthly" | "yearly" | (string & {}); /** Number of billing intervals between recurring charges. Format: int32. */ "billing_interval_count": number; /** Minimum commitment in months, when the plan has one. Format: int32. */ "contract_term_months"?: number; /** Fee charged when the buyer cancels before the contract term ends, when the plan has one. */ "early_termination_fee_money"?: { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** Plan name shown to the buyer. */ "plan_name": string; /** Charge for one billing interval before tax: each line's unit price times its quantity, plus modifiers. */ "recurring_total_money": { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** One-time fee charged with the first payment, when the plan has one. */ "setup_fee_money"?: { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** Flint subscription plan ID the terms come from. */ "subscription_plan_id": string; /** Days before the first recurring charge, when the plan has a trial. Format: int32. */ "trial_period_days"?: number; }; "superseding_checkout_session_id"?: string; "surface": "hosted" | "embedded" | (string & {}); "tax"?: CheckoutTaxConfig; "terminal_reason"?: "payment_succeeded" | "payment_partially_succeeded" | "expired" | "api" | "order_mutated" | "superseded" | "invoice_paid_elsewhere" | "invoice_voided" | "invoice_uncollectible" | "invoice_balance_changed" | (string & {}); "theme"?: ThemeConfig; "tip"?: CheckoutTipConfig; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; /** Hosted checkout URL that carries a one-time launch credential. Send the buyer here to pay. Returned for a hosted session on every launch result: create, payment-link resolve, and invoice and return-resolution checkout. Reads return it only to a credential that can manage checkout sessions. Omitted for embedded sessions. */ "url"?: string; }; "delivery_selection": BuyerDeliverySelection; /** Omitted for checkout credentials, which cannot read the merchant's inventory reservation. Merchant credentials receive it on DeliverySelectionResult. */ "inventory_reservation"?: { /** RFC3339 timestamp. Format: date-time. */ "expires_at": string; "inventory_reservation_id": string; "owner_type": "delivery_selection" | "payment_attempt" | "order_balance_hold" | (string & {}); "required_next_action"?: "none" | "retry_payment" | "replace_selection" | "contact_merchant" | (string & {}); "status": "active" | "closed" | (string & {}); }; /** The order after the change. Merchant-only fields, such as external_reference_id and internal_note, are omitted. */ "order": { "active_payment_attempt"?: { /** RFC3339 timestamp. Format: date-time. */ "completed_at"?: string; "expected_outstanding_money": MoneyValue; /** Reason code for an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.code. Unmapped values are returned as attempt_failed. */ "failure_code"?: "card_declined" | "insufficient_funds" | "bank_account_closed" | "bank_account_not_found" | "bank_debit_not_authorized" | "bank_account_restricted" | "bank_debit_limit_exceeded" | "authentication_required" | "payment_blocked" | "expired_card" | "incorrect_cvc" | "processing_error" | "payment_method_unavailable" | "payment_method_declined" | "payment_not_completed" | "payment_action_expired" | "payment_method_temporarily_unavailable" | "payment_failed" | "authorization_canceled" | "coupon_reservation_failed" | "invalid_payment_source" | "inventory_unavailable" | "order_changed_before_payment" | "order_payment_customer_mismatch" | "payment_attempt_canceled" | "payment_attempt_expired" | "payment_authorization_canceled" | "payment_authorization_expired" | "payment_confirmation_rejected" | "payment_confirm_outcome_unknown" | "payment_link_capacity_claim_failed" | "payment_link_capacity_validation_failed" | "payment_method_activation_pending" | "payment_method_required" | "payment_option_not_allowed" | "payment_option_unavailable" | "payment_source_binding_failed" | "payment_source_conflict" | "payment_source_not_updatable" | "payment_source_ownership_mismatch" | "receipt_email_failed" | "resource_guarantee_failed" | "setup_action_unavailable" | "setup_canceled" | "setup_cancellation_outcome_unknown" | "setup_cancellation_pending" | "setup_confirmation_outcome_unknown" | "setup_hold_acquisition_failed" | "setup_preparation_outcome_unknown" | "setup_processing" | "setup_result_incomplete" | "setup_status_unknown" | "tip_allocation_sync_failed" | "zero_balance_hold_acquisition_failed" | "attempt_failed" | (string & {}); /** Explanation of an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.message. */ "failure_message"?: string; "gift_card_redemptions"?: Array<PaymentAttemptGiftCardRedemption>; /** Whether the attempt can continue through PayOrder with action: resume and this order_payment_attempt_id after any pending client action is complete. If false, check status before starting another payment; the attempt may still be in progress. */ "is_resumable": boolean; "mode": "payment" | "setup" | "settlement" | (string & {}); "order_payment_attempt_id": string; "payment_intents"?: Array<PaymentAttemptPaymentIntent>; "pending_actions"?: Array<PendingPaymentAction>; /** RFC3339 timestamp. Format: date-time. */ "started_at"?: string; "status": "processing" | "requires_action" | "requires_capture" | "partially_succeeded" | "requires_retry" | "finalizing" | "succeeded" | "failed" | "expired" | "canceled" | (string & {}); }; "applied_discounts"?: Array<AppliedDiscount>; "authorization_amounts"?: { "authorized_money": MoneyValue; "capturable_money": MoneyValue; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; }; /** What the buyer can do with the order, in this order: start_return, then resend_receipt. A buyer's read through a customer session on /v1/me, or in Flint's buyer account, lists both every time; a merchant read gets an empty list. A list of orders leaves start_return out, since only a read of one order checks return eligibility. start_return is due when the last open return window ends. Example: []. */ "buyer_actions": Array<BuyerAction>; /** Email and phone saved when payment started, from the pay request's buyer_contact or the paying checkout session's saved contact. It does not change the linked customer. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared": boolean; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared": boolean; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: string; }; "buyer_note"?: string; "charges"?: Array<OrderCharge>; "checkout_session_ids"?: Array<string>; /** The note supplied when the order was closed. It is not shown to the buyer. */ "closed_reason"?: string; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id": string; "email": string; "name"?: string; "phone"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "customer_id"?: string; /** The shipment or local-delivery destination committed for this order. Payment freezes this value; fulfillment recipient changes do not replace it. */ "delivery_destination"?: { "address": OrderDeliveryDestinationAddress; /** Delivery selection that controls this destination, when checkout collected it. */ "delivery_selection_id"?: string; /** Time payment froze this destination. Format: date-time. */ "frozen_at"?: string; "recipient"?: OrderDeliveryDestinationRecipient; "source": "delivery_selection" | "api" | "dashboard" | (string & {}); }; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; "fulfillment_status"?: "not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled" | "not_applicable" | "closed" | (string & {}); "fulfillments"?: Array<Fulfillment>; "gift_card_estimate"?: { "can_pay": boolean; "gift_card_money": MoneyValue; "gift_cards": Array<OrderGiftCardAllocation>; "is_reserved": boolean; /** Use an exact numeric string, not a floating-point number. Format: int64. */ "order_revision": string; "processor_money": MoneyValue; }; "gift_card_settlements"?: Array<OrderGiftCardSettlement>; "gift_card_tender_enabled"?: boolean; "gift_cards"?: Array<OrderGiftCardSelection>; "internal_note"?: string; "inventory_exception_status"?: "paid_inventory_failed" | "resolved" | (string & {}); /** The reservation holding stock for this order, when one exists. */ "inventory_reservation_id"?: string; /** Where this order's tracked demand is routed. Required before an order containing tracked variants can hold stock. */ "inventory_routing_source"?: { "inventory_allocation_policy_id"?: string; "inventory_allocation_policy_version_id"?: string; "location_id"?: string; "location_ids"?: Array<string>; "type": "fixed_location" | "policy" | "policy_version" | (string & {}); }; "line_items": Array<OrderLineItem>; "merchant_id"?: string; "metadata"?: Record<string, string>; "order_id": string; "order_number"?: string; /** Use an exact numeric string, not a floating-point number. Format: int64. */ "order_revision"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription" | (string & {}); "payment_collection"?: { "stripe"?: PaymentCollectionStripe; }; "payment_intent_ids"?: Array<string>; "payment_intents"?: Array<ExpandedPaymentIntentSummary>; "payment_status": "unpaid" | "partially_paid" | "paid" | (string & {}); "pricing_amounts": { "charge_money": MoneyValue; "discount_money": MoneyValue; "requested_tip_money": MoneyValue; "subtotal_money": MoneyValue; "tax_money": MoneyValue; "total_money": MoneyValue; }; "purchased_event"?: { "location"?: string; "name": string; /** RFC3339 timestamp. Format: date-time. */ "starts_at"?: string; "timezone"?: string; }; "refund_ids"?: Array<string>; "refund_status": "none" | "partially_refunded" | "refunded" | (string & {}); "requested_tip"?: RequestedTip; /** Value applied to this order from items the buyer returned, such as an exchange's replacement order. Included in settlement_amounts.paid_money. */ "return_credit_settlements"?: Array<OrderReturnCreditSettlement>; "settlement_amounts": { "balance_money": SignedMoney; "credit_money": MoneyValue; "net_collected_money": MoneyValue; "outstanding_money": MoneyValue; "paid_money": MoneyValue; "refunded_money": MoneyValue; "settled_tip_money": MoneyValue; }; "setup_collection"?: { "stripe"?: PaymentCollectionStripe; }; "status": "open" | "closed" | (string & {}); "subscription"?: (({ /** Format: int32. */ "billing_anchor_day": number; "cancel_at_period_end": boolean; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "current_period_end"?: string; "current_period_start"?: string; "customer_id": string; /** RFC3339 timestamp. Format: date-time. */ "next_billing_at"?: string; "status": "trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete" | (string & {}); "subscription_id": string; "subscription_plan_id": string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "subscription_id"?: string; "subscription_plan"?: (({ "billing_interval": "daily" | "weekly" | "monthly" | "yearly" | (string & {}); /** Format: int32. */ "billing_interval_count": number; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; /** ISO 4217 currency code. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; "description"?: string; "line_items"?: Array<SubscriptionPlanLineItem>; "name": string; "setup_fee_money"?: MoneyValue; "status": "active" | "archived" | (string & {}); "subscription_plan_id": string; /** Format: int32. */ "trial_period_days"?: number; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "subscription_plan_id"?: string; "tax": { /** Identifies which automatic tax behavior applies to this order. connected means the account's tax connection calculated it. standard marks an order calculated before automatic tax required a tax connection. */ "automatic_profile"?: "standard" | "connected" | (string & {}); "available_location_inputs"?: Array<string>; "enabled": boolean; "exemption"?: OrderTaxExemption; /** Normalized reason the most recent tax calculation could not complete. */ "failure_reason"?: "calculation_unavailable" | "location_unsupported" | "rate_unavailable" | (string & {}); "location"?: OrderTaxLocation; "mode": "automatic" | "external" | (string & {}); "status": "not_required" | "requires_location" | "calculated" | "exempt" | "incomplete" | (string & {}); "tax_breakdowns"?: Array<TaxBreakdown>; /** Explains why tax was charged or zero for this order. */ "taxability_reason": "standard_rated" | "not_taxable" | "customer_exempt" | "tax_disabled" | "no_jurisdiction" | "location_required" | (string & {}); }; "tips"?: Array<Tip>; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }; }) | (object)); "meta"?: ResponseMeta; "request_id"?: string; };

package/declarations/CheckoutDeliverySelectionResultResponseInput.d.ts

@@ -19,4 +19,4 @@ import type { RequestedTipInput } from './RequestedTipInput.js';
 import type { ResponseMetaInput } from './ResponseMetaInput.js';
 import type { ThemeConfigInput } from './ThemeConfigInput.js';
 
-export type CheckoutDeliverySelectionResultResponseInput = { "data": (({ "audience": ("merchant") & ("merchant"); "checkout_session": CheckoutSessionInput; "delivery_selection": DeliverySelectionInput; "inventory_reservation"?: DeliveryInventoryReservationSummaryInput; "order": OrderInput; }) | ({ "audience": ("buyer") & ("buyer"); /** The checkout session after the change. Merchant-only fields, such as metadata and external_reference_id, are omitted. */ "checkout_session": { "active_payment_attempt"?: never; /** Contact the buyer entered in checkout before paying, saved with the session's checkout credential. Omitted until the buyer saves or clears a field. When a checkout session payment omits buyer_contact.email or buyer_contact.phone, Flint uses these values. Flint clears the contact 30 days after the session ends, and when a customer linked to the session is deleted. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared"?: never; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared"?: never; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: never; }; "checkout_session_id"?: never; /** The note supplied when the checkout session was closed. It is not shown to the buyer. */ "closed_reason"?: never; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: never; "custom_text"?: CheckoutCustomTextWriteConfigInput; "customer"?: never; "customer_collection"?: CheckoutCustomerConfigInput; /** Contact and default addresses of the customer the checkout acts for: the customer the merchant created the session for, or the customer whose email the buyer confirmed in it. Present only on reads with the session's checkout credential while the session is open and acts for a customer. */ "customer_prefill"?: never; /** Immutable delivery method assignment captured when the checkout was created. */ "delivery_method_ids": Array<string>; /** Merchant-only immutable configuration lineage used to evaluate delivery quotes. */ "delivery_pinned_dependencies"?: never; /** Whether the order has at least one remaining quote-resolved fulfillment choice that must be selected before payment. */ "delivery_selection_required"?: never; "expiration"?: CheckoutExpirationConfigInput; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: never; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; /** Current fulfillment choices for Flint-owned pricing. Checkout credentials receive the fields available to buyers; merchant credentials also receive configuration lineage and diagnostics. External pricing reports requires_explicit_quote; reading this field does not request a delivery quote. Omitted when the session is not open, has no order, or Flint cannot read its delivery. */ "fulfillment"?: never; "invoice"?: never; "invoice_id"?: never; "legal"?: LegalSettingsInput; "merchant_id"?: never; /** How the buyer can reach the merchant for help: the support email, phone, and URL the merchant set. Present only on reads with the session's checkout credential, and only when the merchant set at least one of them. Show it where your checkout tells the buyer to contact the merchant, such as an expired or closed checkout, or your receipt. */ "merchant_support"?: never; "metadata"?: Record<string, string>; "order"?: never; "order_id"?: string; "origin"?: never; "payment_collection"?: never; "payment_intent_ids"?: never; "payment_intents"?: never; "payment_link"?: never; "payment_link_id"?: never; /** The card the buyer saved with this checkout's payment by giving a mobile phone number, and whether they confirmed it. Present only on reads with the session's checkout credential, after a payment that paid the order in full, or that was approved for the merchant to capture later, and saved a card this way. A checkout whose payment is approved stays open until the capture. */ "payment_method_save"?: never; "payments"?: CheckoutPaymentConfigInput; /** Named conditions that affect checkout completion. Follow each problem's remediation action instead of reconstructing delivery lifecycle rules in the client. When Flint cannot read the checkout's delivery, the read still succeeds and reports delivery_selection_stale; its remediation says whether reading the session again can succeed, and its next action's reason_code names the error. */ "problems"?: never; "promotion_config"?: CheckoutPromotionConfigInput; /** RFC3339 deadline for the restricted payment-attempt recovery window. Format: date-time. */ "recovery_expires_at"?: never; /** Whether this terminal session credential is temporarily restricted to recovering its owning payment attempt. */ "recovery_mode"?: never; /** Payment attempt that this checkout credential may recover while recovery_mode is true. */ "recovery_payment_attempt_id"?: never; "redirects"?: CheckoutRedirectsConfigInput; /** Whether checkout offers the buyer the option to save the card they type for faster checkout at this merchant. Present only on reads with the session's checkout credential. When true and save_payment_method_requires_verification is false, PayOrder accepts save_payment_method: true for one newly collected card. False when the merchant turned checkout.saved_payment_details off, customer accounts are merchant hosted, card is not an available payment option, the checkout collects an invoice, a subscription, or a return, or the checkout acts for no customer and Flint cannot email the buyer a verification code. */ "save_payment_method_offered"?: never; /** Whether the buyer can save the card they type by giving a US or Canadian mobile phone number with the payment, in save_payment_method_phone on POST /v1/orders/{order_id}/pay, and confirming it with a texted code after paying. Present only on reads with the session's checkout credential. True while Flint can send texts and either save_payment_method_requires_verification is true, so the number replaces confirming an email before paying, or the checkout acts for the customer whose email the buyer confirmed with this credential, so the number joins that customer's saved details once the buyer confirms it. */ "save_payment_method_phone_offered"?: never; /** Whether the buyer must confirm their email with a code before the checkout can save their card or use their saved cards. Present only on reads with the session's checkout credential. True when save_payment_method_offered is true and the checkout acts for no customer for this credential: the merchant created it without one, and either the buyer has not confirmed an email with this credential, or the customer whose email they confirmed has since changed that email or been deleted. A credential other than the one a confirmation returned, such as the hosted checkout link opened on another device, reads true. Send the code with POST /v1/checkout-sessions/{checkout_session_id}/customer-verifications. False while the checkout acts for a customer, and whenever save_payment_method_offered is false. */ "save_payment_method_requires_verification"?: never; "setup_collection"?: never; "status"?: never; "subscription_plan_id"?: never; /** Renewal terms a subscription checkout commits the buyer to. Frozen when the session's order was created, so later plan changes do not alter them. Absent when the checkout starts no subscription. */ "subscription_terms"?: never; "superseding_checkout_session_id"?: never; "surface": "hosted" | "embedded"; "tax"?: CheckoutTaxConfigInput; "terminal_reason"?: never; "theme"?: ThemeConfigInput; "tip"?: CheckoutTipConfigInput; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: never; "url"?: never; }; "delivery_selection": BuyerDeliverySelectionInput; /** Omitted for checkout credentials, which cannot read the merchant's inventory reservation. Merchant credentials receive it on DeliverySelectionResult. */ "inventory_reservation"?: { /** RFC3339 timestamp. Format: date-time. */ "expires_at": string | globalThis.Date; "inventory_reservation_id": string; "owner_type": "delivery_selection" | "payment_attempt" | "order_balance_hold"; "required_next_action"?: "none" | "retry_payment" | "replace_selection" | "contact_merchant"; "status": "active" | "closed"; }; /** The order after the change. Merchant-only fields, such as external_reference_id and internal_note, are omitted. */ "order": { "active_payment_attempt"?: never; "applied_discounts"?: never; "authorization_amounts"?: never; /** What the buyer can do with the order, in this order: start_return, then resend_receipt. A buyer's read through a customer session on /v1/me, or in Flint's buyer account, lists both every time; a merchant read gets an empty list. A list of orders leaves start_return out, since only a read of one order checks return eligibility. start_return is due when the last open return window ends. Example: []. */ "buyer_actions"?: never; /** Email and phone saved when payment started, from the pay request's buyer_contact or the paying checkout session's saved contact. It does not change the linked customer. */ "buyer_contact"?: never; "buyer_note"?: string; "charges"?: never; "checkout_session_ids"?: never; /** The note supplied when the order was closed. It is not shown to the buyer. */ "closed_reason"?: never; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: never; "customer"?: never; "customer_id"?: string; /** The shipment or local-delivery destination committed for this order. Payment freezes this value; fulfillment recipient changes do not replace it. */ "delivery_destination"?: { "address": OrderDeliveryDestinationAddressInput; /** Delivery selection that controls this destination, when checkout collected it. */ "delivery_selection_id"?: string; /** Time payment froze this destination. Format: date-time. */ "frozen_at"?: string | globalThis.Date; "recipient"?: OrderDeliveryDestinationRecipientInput; "source": "delivery_selection" | "api" | "dashboard"; }; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; "fulfillment_status"?: never; "fulfillments"?: never; "gift_card_estimate"?: never; "gift_card_settlements"?: never; "gift_card_tender_enabled"?: never; "gift_cards"?: never; "internal_note"?: string; "inventory_exception_status"?: never; /** The reservation holding stock for this order, when one exists. */ "inventory_reservation_id"?: never; /** Where this order's tracked demand is routed. Required before an order containing tracked variants can hold stock. */ "inventory_routing_source"?: { "inventory_allocation_policy_id"?: string; "inventory_allocation_policy_version_id"?: string; "location_id"?: string; "location_ids"?: Array<string>; "type": "fixed_location" | "policy" | "policy_version"; }; "line_items"?: never; "merchant_id"?: never; "metadata"?: Record<string, string>; "order_id"?: never; "order_number"?: never; /** Use an exact numeric string, not a floating-point number. Format: int64. */ "order_revision"?: never; "origin"?: never; "payment_collection"?: never; "payment_intent_ids"?: never; "payment_intents"?: never; "payment_status"?: never; "pricing_amounts"?: never; "purchased_event"?: never; "refund_ids"?: never; "refund_status"?: never; "requested_tip"?: RequestedTipInput; /** Value applied to this order from items the buyer returned, such as an exchange's replacement order. Included in settlement_amounts.paid_money. */ "return_credit_settlements"?: never; "settlement_amounts"?: never; "setup_collection"?: never; "status"?: never; "subscription"?: never; "subscription_id"?: never; "subscription_plan"?: never; "subscription_plan_id"?: never; "tax"?: never; "tips"?: never; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: never; }; })); "meta"?: ResponseMetaInput; "request_id"?: string; };
+export type CheckoutDeliverySelectionResultResponseInput = { "data": (({ "audience": ("merchant") & ("merchant"); "checkout_session": CheckoutSessionInput; "delivery_selection": DeliverySelectionInput; "inventory_reservation"?: DeliveryInventoryReservationSummaryInput; "order": OrderInput; }) | ({ "audience": ("buyer") & ("buyer"); /** The checkout session after the change. Merchant-only fields, such as metadata and external_reference_id, are omitted. */ "checkout_session": { "active_payment_attempt"?: never; /** Contact the buyer entered in checkout before paying, saved with the session's checkout credential. Omitted until the buyer saves or clears a field. When a checkout session payment omits buyer_contact.email or buyer_contact.phone, Flint uses these values. Flint clears the contact 30 days after the session ends, and when a customer linked to the session is deleted. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared"?: never; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared"?: never; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: never; }; "checkout_session_id"?: never; /** The note supplied when the checkout session was closed. It is not shown to the buyer. */ "closed_reason"?: never; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: never; "custom_text"?: CheckoutCustomTextWriteConfigInput; "customer"?: never; "customer_collection"?: CheckoutCustomerConfigInput; /** Contact and default addresses of the customer the checkout acts for: the customer the merchant created the session for, or the customer whose email the buyer confirmed in it. Present only on reads with the session's checkout credential while the session is open and acts for a customer. */ "customer_prefill"?: never; /** Immutable delivery method assignment captured when the checkout was created. */ "delivery_method_ids": Array<string>; /** Merchant-only immutable configuration lineage used to evaluate delivery quotes. */ "delivery_pinned_dependencies"?: never; /** Whether the order has at least one remaining quote-resolved fulfillment choice that must be selected before payment. */ "delivery_selection_required"?: never; "expiration"?: CheckoutExpirationConfigInput; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: never; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; /** Current fulfillment choices for Flint-owned pricing. Checkout credentials receive the fields available to buyers; merchant credentials also receive configuration lineage and diagnostics. External pricing reports requires_explicit_quote; reading this field does not request a delivery quote. Omitted when the session is not open, has no order, or Flint cannot read its delivery. */ "fulfillment"?: never; "invoice"?: never; "invoice_id"?: never; "legal"?: LegalSettingsInput; "merchant_id"?: never; /** How the buyer can reach the merchant for help: the support email, phone, and URL the merchant set. Present only on reads with the session's checkout credential, and only when the merchant set at least one of them. Show it where your checkout tells the buyer to contact the merchant, such as an expired or closed checkout, or your receipt. */ "merchant_support"?: never; "metadata"?: Record<string, string>; "order"?: never; "order_id"?: string; "origin"?: never; "payment_collection"?: never; "payment_intent_ids"?: never; "payment_intents"?: never; "payment_link"?: never; "payment_link_id"?: never; /** The card the buyer saved with this checkout's payment by giving a mobile phone number, and whether they confirmed it. Present only on reads with the session's checkout credential, after a payment that paid the order in full, or that was approved for the merchant to capture later, and saved a card this way. A checkout whose payment is approved stays open until the capture. */ "payment_method_save"?: never; "payments"?: CheckoutPaymentConfigInput; /** Named conditions that affect checkout completion. Follow each problem's remediation action instead of reconstructing delivery lifecycle rules in the client. When Flint cannot read the checkout's delivery, the read still succeeds and reports delivery_selection_stale; its remediation says whether reading the session again can succeed, and its next action's reason_code names the error. */ "problems"?: never; "promotion_config"?: CheckoutPromotionConfigInput; /** RFC3339 deadline for the restricted payment-attempt recovery window. Format: date-time. */ "recovery_expires_at"?: never; /** Whether this terminal session credential is temporarily restricted to recovering its owning payment attempt. */ "recovery_mode"?: never; /** Payment attempt that this checkout credential may recover while recovery_mode is true. */ "recovery_payment_attempt_id"?: never; "redirects"?: CheckoutRedirectsConfigInput; /** Whether checkout offers the buyer the option to save the card they type for faster checkout at this merchant. Present only on reads with the session's checkout credential. When true and save_payment_method_requires_verification is false, PayOrder accepts save_payment_method: true for one newly collected card. False when the merchant turned checkout.saved_payment_details off, customer accounts are merchant hosted, card is not an available payment option, the checkout collects an invoice, a subscription, or a return, or the checkout acts for no customer and Flint cannot email the buyer a verification code. */ "save_payment_method_offered"?: never; /** Whether the buyer can save the card they type by giving a US or Canadian mobile phone number with the payment, in save_payment_method_phone on POST /v1/orders/{order_id}/pay, and confirming it with a texted code after paying. Present only on reads with the session's checkout credential. True while Flint can send texts and either save_payment_method_requires_verification is true, so the number replaces confirming an email before paying, or the checkout acts for the customer whose email the buyer confirmed with this credential, so the number joins that customer's saved details once the buyer confirms it. */ "save_payment_method_phone_offered"?: never; /** Whether the buyer must confirm their email with a code before the checkout can save their card or use their saved cards. Present only on reads with the session's checkout credential. True when save_payment_method_offered is true and the checkout acts for no customer for this credential: the merchant created it without one, and either the buyer has not confirmed an email with this credential, or the customer whose email they confirmed has since changed that email or been deleted. A credential other than the one a confirmation returned, such as the hosted checkout link opened on another device, reads true. Send the code with POST /v1/checkout-sessions/{checkout_session_id}/customer-verifications. False while the checkout acts for a customer, and whenever save_payment_method_offered is false. */ "save_payment_method_requires_verification"?: never; "setup_collection"?: never; "status"?: never; "subscription_plan_id"?: never; /** Renewal terms a subscription checkout commits the buyer to. Frozen when the session's order was created, so later plan changes do not alter them. Absent when the checkout starts no subscription. */ "subscription_terms"?: never; "superseding_checkout_session_id"?: never; "surface": "hosted" | "embedded"; "tax"?: CheckoutTaxConfigInput; "terminal_reason"?: never; "theme"?: ThemeConfigInput; "tip"?: CheckoutTipConfigInput; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: never; /** Hosted checkout URL that carries a one-time launch credential. Send the buyer here to pay. Returned for a hosted session on every launch result: create, payment-link resolve, and invoice and return-resolution checkout. Reads return it only to a credential that can manage checkout sessions. Omitted for embedded sessions. */ "url"?: never; }; "delivery_selection": BuyerDeliverySelectionInput; /** Omitted for checkout credentials, which cannot read the merchant's inventory reservation. Merchant credentials receive it on DeliverySelectionResult. */ "inventory_reservation"?: { /** RFC3339 timestamp. Format: date-time. */ "expires_at": string | globalThis.Date; "inventory_reservation_id": string; "owner_type": "delivery_selection" | "payment_attempt" | "order_balance_hold"; "required_next_action"?: "none" | "retry_payment" | "replace_selection" | "contact_merchant"; "status": "active" | "closed"; }; /** The order after the change. Merchant-only fields, such as external_reference_id and internal_note, are omitted. */ "order": { "active_payment_attempt"?: never; "applied_discounts"?: never; "authorization_amounts"?: never; /** What the buyer can do with the order, in this order: start_return, then resend_receipt. A buyer's read through a customer session on /v1/me, or in Flint's buyer account, lists both every time; a merchant read gets an empty list. A list of orders leaves start_return out, since only a read of one order checks return eligibility. start_return is due when the last open return window ends. Example: []. */ "buyer_actions"?: never; /** Email and phone saved when payment started, from the pay request's buyer_contact or the paying checkout session's saved contact. It does not change the linked customer. */ "buyer_contact"?: never; "buyer_note"?: string; "charges"?: never; "checkout_session_ids"?: never; /** The note supplied when the order was closed. It is not shown to the buyer. */ "closed_reason"?: never; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: never; "customer"?: never; "customer_id"?: string; /** The shipment or local-delivery destination committed for this order. Payment freezes this value; fulfillment recipient changes do not replace it. */ "delivery_destination"?: { "address": OrderDeliveryDestinationAddressInput; /** Delivery selection that controls this destination, when checkout collected it. */ "delivery_selection_id"?: string; /** Time payment froze this destination. Format: date-time. */ "frozen_at"?: string | globalThis.Date; "recipient"?: OrderDeliveryDestinationRecipientInput; "source": "delivery_selection" | "api" | "dashboard"; }; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; "fulfillment_status"?: never; "fulfillments"?: never; "gift_card_estimate"?: never; "gift_card_settlements"?: never; "gift_card_tender_enabled"?: never; "gift_cards"?: never; "internal_note"?: string; "inventory_exception_status"?: never; /** The reservation holding stock for this order, when one exists. */ "inventory_reservation_id"?: never; /** Where this order's tracked demand is routed. Required before an order containing tracked variants can hold stock. */ "inventory_routing_source"?: { "inventory_allocation_policy_id"?: string; "inventory_allocation_policy_version_id"?: string; "location_id"?: string; "location_ids"?: Array<string>; "type": "fixed_location" | "policy" | "policy_version"; }; "line_items"?: never; "merchant_id"?: never; "metadata"?: Record<string, string>; "order_id"?: never; "order_number"?: never; /** Use an exact numeric string, not a floating-point number. Format: int64. */ "order_revision"?: never; "origin"?: never; "payment_collection"?: never; "payment_intent_ids"?: never; "payment_intents"?: never; "payment_status"?: never; "pricing_amounts"?: never; "purchased_event"?: never; "refund_ids"?: never; "refund_status"?: never; "requested_tip"?: RequestedTipInput; /** Value applied to this order from items the buyer returned, such as an exchange's replacement order. Included in settlement_amounts.paid_money. */ "return_credit_settlements"?: never; "settlement_amounts"?: never; "setup_collection"?: never; "status"?: never; "subscription"?: never; "subscription_id"?: never; "subscription_plan"?: never; "subscription_plan_id"?: never; "tax"?: never; "tips"?: never; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: never; }; })); "meta"?: ResponseMetaInput; "request_id"?: string; };

package/declarations/CheckoutExpirationConfig.d.ts

@@ -1,4 +1,4 @@
 
 
 
-export type CheckoutExpirationConfig = { /** Optional URL to send buyers to after the checkout session expires. */ "expiration_url"?: string; /** Duration in seconds before the checkout session expires after creation. Use an exact numeric string, not a floating-point number. Format: int64. */ "expires_in_seconds"?: string; };
+export type CheckoutExpirationConfig = { /** Optional URL to send buyers to after the checkout session expires. */ "expiration_url"?: string; /** Duration in seconds before the checkout session expires after creation. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 60. maximum: 86400. */ "expires_in_seconds"?: string; };

package/declarations/CheckoutSession.d.ts

@@ -25,4 +25,4 @@ import type { PricingAmounts } from './PricingAmounts.js';
 import type { SettlementAmounts } from './SettlementAmounts.js';
 import type { ThemeConfig } from './ThemeConfig.js';
 
-export type CheckoutSession = { "active_payment_attempt"?: { /** RFC3339 timestamp. Format: date-time. */ "completed_at"?: string; "expected_outstanding_money": MoneyValue; /** Reason code for an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.code. Unmapped values are returned as attempt_failed. */ "failure_code"?: "card_declined" | "insufficient_funds" | "bank_account_closed" | "bank_account_not_found" | "bank_debit_not_authorized" | "bank_account_restricted" | "bank_debit_limit_exceeded" | "authentication_required" | "payment_blocked" | "expired_card" | "incorrect_cvc" | "processing_error" | "payment_method_unavailable" | "payment_method_declined" | "payment_not_completed" | "payment_action_expired" | "payment_method_temporarily_unavailable" | "payment_failed" | "authorization_canceled" | "coupon_reservation_failed" | "invalid_payment_source" | "inventory_unavailable" | "order_changed_before_payment" | "order_payment_customer_mismatch" | "payment_attempt_canceled" | "payment_attempt_expired" | "payment_authorization_canceled" | "payment_authorization_expired" | "payment_confirmation_rejected" | "payment_confirm_outcome_unknown" | "payment_link_capacity_claim_failed" | "payment_link_capacity_validation_failed" | "payment_method_activation_pending" | "payment_method_required" | "payment_option_not_allowed" | "payment_option_unavailable" | "payment_source_binding_failed" | "payment_source_conflict" | "payment_source_not_updatable" | "payment_source_ownership_mismatch" | "receipt_email_failed" | "resource_guarantee_failed" | "setup_action_unavailable" | "setup_canceled" | "setup_cancellation_outcome_unknown" | "setup_cancellation_pending" | "setup_confirmation_outcome_unknown" | "setup_hold_acquisition_failed" | "setup_preparation_outcome_unknown" | "setup_processing" | "setup_result_incomplete" | "setup_status_unknown" | "tip_allocation_sync_failed" | "zero_balance_hold_acquisition_failed" | "attempt_failed" | (string & {}); /** Explanation of an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.message. */ "failure_message"?: string; "gift_card_redemptions"?: Array<PaymentAttemptGiftCardRedemption>; /** Whether the attempt can continue through PayOrder with action: resume and this order_payment_attempt_id after any pending client action is complete. If false, check status before starting another payment; the attempt may still be in progress. */ "is_resumable": boolean; "mode": "payment" | "setup" | "settlement" | (string & {}); "order_payment_attempt_id": string; "payment_intents"?: Array<PaymentAttemptPaymentIntent>; "pending_actions"?: Array<PendingPaymentAction>; /** RFC3339 timestamp. Format: date-time. */ "started_at"?: string; "status": "processing" | "requires_action" | "requires_capture" | "partially_succeeded" | "requires_retry" | "finalizing" | "succeeded" | "failed" | "expired" | "canceled" | (string & {}); }; /** Contact the buyer entered in checkout before paying, saved with the session's checkout credential. Omitted until the buyer saves or clears a field. When a checkout session payment omits buyer_contact.email or buyer_contact.phone, Flint uses these values. Flint clears the contact 30 days after the session ends, and when a customer linked to the session is deleted. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared": boolean; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared": boolean; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: string; }; "checkout_session_id": string; /** The note supplied when the checkout session was closed. It is not shown to the buyer. */ "closed_reason"?: string; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "custom_text"?: CheckoutCustomTextWriteConfig; "customer"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id": string; "email": string; "name"?: string; "phone"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "customer_collection"?: CheckoutCustomerConfig; /** Contact and default addresses of the customer the checkout acts for: the customer the merchant created the session for, or the customer whose email the buyer confirmed in it. Present only on reads with the session's checkout credential while the session is open and acts for a customer. */ "customer_prefill"?: { /** The customer's default billing address. Omitted when the customer has none. */ "billing_address"?: { "city": string; /** ISO 3166-1 alpha-2 country code. minLength: 2. maxLength: 2. pattern: ^[A-Z]{2}$. Example: "US". */ "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; }; /** The customer's email. */ "email": string; /** The customer's default shipping address. Omitted when the customer has none. */ "shipping_address"?: { "city": string; /** ISO 3166-1 alpha-2 country code. minLength: 2. maxLength: 2. pattern: ^[A-Z]{2}$. Example: "US". */ "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; }; }; /** Immutable delivery method assignment captured when the checkout was created. */ "delivery_method_ids": Array<string>; /** Merchant-only immutable configuration lineage used to evaluate delivery quotes. */ "delivery_pinned_dependencies"?: Array<CheckoutDeliveryPinnedDependency>; /** Whether the order has at least one remaining quote-resolved fulfillment choice that must be selected before payment. */ "delivery_selection_required": boolean; "expiration"?: CheckoutExpirationConfig; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; /** Current fulfillment choices for Flint-owned pricing. Checkout credentials receive the fields available to buyers; merchant credentials also receive configuration lineage and diagnostics. External pricing reports requires_explicit_quote; reading this field does not request a delivery quote. Omitted when the session is not open, has no order, or Flint cannot read its delivery. */ "fulfillment"?: (({ "choice_groups": Array<DeliveryQuoteChoiceGroupResource>; "delivery_quote_id"?: string; "evaluation_status": "complete" | "incomplete" | "degraded" | "requires_explicit_quote" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Inputs the checkout's delivery methods need. Once the checkout has a delivery quote, these are the quote's input_requirements. Before that, they come from the methods alone and name no choice group: the fields in each method's quote_input_fields, and each recipient field a method requires. */ "input_requirements": Array<DeliveryInputRequirement>; "merchant_diagnostics": Array<DeliveryMerchantDiagnostic>; }) | ({ "buyer_reasons": Array<string>; "choice_groups": Array<BuyerDeliveryQuoteChoiceGroupResource>; "delivery_quote_id"?: string; "evaluation_status": "complete" | "incomplete" | "degraded" | "requires_explicit_quote" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Inputs the checkout's delivery methods need. Once the checkout has a delivery quote, these are the quote's input_requirements. Before that, they come from the methods alone and name no choice group: the fields in each method's quote_input_fields, and each recipient field a method requires. */ "input_requirements": Array<BuyerDeliveryInputRequirementResource>; }) | (object)); "invoice"?: (({ "collection_block_status"?: "none" | "inventory_blocked" | "resolved" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id"?: string; /** RFC3339 timestamp. Format: date-time. */ "due_at"?: string; "invoice_id": string; "invoice_number"?: string; "is_overdue": boolean; "order_id"?: string; "outstanding_money": MoneyValue; "paid_money": MoneyValue; "refund_status"?: "none" | "partially_refunded" | "refunded" | (string & {}); "refunded_money": MoneyValue; "status": "draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "invoice_id"?: string; "legal"?: LegalSettings; "merchant_id"?: string; /** How the buyer can reach the merchant for help: the support email, phone, and URL the merchant set. Present only on reads with the session's checkout credential, and only when the merchant set at least one of them. Show it where your checkout tells the buyer to contact the merchant, such as an expired or closed checkout, or your receipt. */ "merchant_support"?: { /** Support email address. Format: email. */ "email"?: string; /** Support phone number. */ "phone"?: string; /** Support page, as an absolute http or https URL. Format: uri. */ "url"?: string; }; "metadata"?: Record<string, string>; "order"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id"?: string; "fulfillment_status"?: "not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled" | "not_applicable" | "closed" | (string & {}); "order_id": string; "order_number"?: string; "payment_intent_ids"?: Array<string>; "payment_status": "unpaid" | "partially_paid" | "paid" | (string & {}); "pricing_amounts": PricingAmounts; "refund_status": "none" | "partially_refunded" | "refunded" | (string & {}); "settlement_amounts": SettlementAmounts; "status": "open" | "closed" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "order_id"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription" | (string & {}); "payment_collection"?: { "stripe"?: PaymentCollectionStripe; }; "payment_intent_ids"?: Array<string>; "payment_intents"?: Array<ExpandedPaymentIntentSummary>; "payment_link"?: (({ /** Format: int32. */ "completed_count": number; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "description"?: string; "name": string; "payment_link_id": string; "payment_link_type"?: "standard" | "donation" | "event" | (string & {}); "status": "active" | "inactive" | (string & {}); "subscription_plan_id"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; "url"?: string; }) | (null)); "payment_link_id"?: string; /** The card the buyer saved with this checkout's payment by giving a mobile phone number, and whether they confirmed it. Present only on reads with the session's checkout credential, after a payment that paid the order in full, or that was approved for the merchant to capture later, and saved a card this way. A checkout whose payment is approved stays open until the capture. */ "payment_method_save"?: { /** True while status is pending after the buyer confirmed the number by text, when the number alone can't save the card: the customer with the buyer's email existed before this payment, the buyer did not confirm that email in this checkout, and the number isn't already the customer's saved number with an active card saved with it. The buyer confirms the email with an emailed code to finish; the card is then saved with the number, which replaces the customer's saved number. */ "email_confirmation_required": boolean; /** When a pending save stops waiting: 24 hours after the payment succeeded or was approved. Format: date-time. */ "expires_at"?: string | null; /** Last two digits of the number the buyer gave, which a code is texted to. Set while status is pending. */ "phone_last_digits"?: string; "saved_with"?: "sms" | "email" | (string & {}); "status": "pending" | "saved" | "expired" | (string & {}); }; "payments"?: CheckoutPaymentConfig; /** Named conditions that affect checkout completion. Follow each problem's remediation action instead of reconstructing delivery lifecycle rules in the client. When Flint cannot read the checkout's delivery, the read still succeeds and reports delivery_selection_stale; its remediation says whether reading the session again can succeed, and its next action's reason_code names the error. */ "problems": Array<CheckoutProblemResource>; "promotion_config"?: CheckoutPromotionConfig; /** RFC3339 deadline for the restricted payment-attempt recovery window. Format: date-time. */ "recovery_expires_at"?: string | null; /** Whether this terminal session credential is temporarily restricted to recovering its owning payment attempt. */ "recovery_mode": boolean; /** Payment attempt that this checkout credential may recover while recovery_mode is true. */ "recovery_payment_attempt_id"?: string; "redirects"?: CheckoutRedirectsConfig; /** Whether checkout offers the buyer the option to save the card they type for faster checkout at this merchant. Present only on reads with the session's checkout credential. When true and save_payment_method_requires_verification is false, PayOrder accepts save_payment_method: true for one newly collected card. False when the merchant turned checkout.saved_payment_details off, customer accounts are merchant hosted, card is not an available payment option, the checkout collects an invoice, a subscription, or a return, or the checkout acts for no customer and Flint cannot email the buyer a verification code. */ "save_payment_method_offered"?: boolean; /** Whether the buyer can save the card they type by giving a US or Canadian mobile phone number with the payment, in save_payment_method_phone on POST /v1/orders/{order_id}/pay, and confirming it with a texted code after paying. Present only on reads with the session's checkout credential. True while Flint can send texts and either save_payment_method_requires_verification is true, so the number replaces confirming an email before paying, or the checkout acts for the customer whose email the buyer confirmed with this credential, so the number joins that customer's saved details once the buyer confirms it. */ "save_payment_method_phone_offered"?: boolean; /** Whether the buyer must confirm their email with a code before the checkout can save their card or use their saved cards. Present only on reads with the session's checkout credential. True when save_payment_method_offered is true and the checkout acts for no customer for this credential: the merchant created it without one, and either the buyer has not confirmed an email with this credential, or the customer whose email they confirmed has since changed that email or been deleted. A credential other than the one a confirmation returned, such as the hosted checkout link opened on another device, reads true. Send the code with POST /v1/checkout-sessions/{checkout_session_id}/customer-verifications. False while the checkout acts for a customer, and whenever save_payment_method_offered is false. */ "save_payment_method_requires_verification"?: boolean; "setup_collection"?: { "stripe"?: PaymentCollectionStripe; }; "status": "open" | "paid" | "partially_paid" | "expired" | "closed" | "invalidated" | (string & {}); "subscription_plan_id"?: string; /** Renewal terms a subscription checkout commits the buyer to. Frozen when the session's order was created, so later plan changes do not alter them. Absent when the checkout starts no subscription. */ "subscription_terms"?: { "billing_interval": "daily" | "weekly" | "monthly" | "yearly" | (string & {}); /** Number of billing intervals between recurring charges. Format: int32. */ "billing_interval_count": number; /** Minimum commitment in months, when the plan has one. Format: int32. */ "contract_term_months"?: number; /** Fee charged when the buyer cancels before the contract term ends, when the plan has one. */ "early_termination_fee_money"?: { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** Plan name shown to the buyer. */ "plan_name": string; /** Charge for one billing interval before tax: each line's unit price times its quantity, plus modifiers. */ "recurring_total_money": { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** One-time fee charged with the first payment, when the plan has one. */ "setup_fee_money"?: { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** Flint subscription plan ID the terms come from. */ "subscription_plan_id": string; /** Days before the first recurring charge, when the plan has a trial. Format: int32. */ "trial_period_days"?: number; }; "superseding_checkout_session_id"?: string; "surface": "hosted" | "embedded" | (string & {}); "tax"?: CheckoutTaxConfig; "terminal_reason"?: "payment_succeeded" | "payment_partially_succeeded" | "expired" | "api" | "order_mutated" | "superseded" | "invoice_paid_elsewhere" | "invoice_voided" | "invoice_uncollectible" | "invoice_balance_changed" | (string & {}); "theme"?: ThemeConfig; "tip"?: CheckoutTipConfig; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; "url"?: string; };
+export type CheckoutSession = { "active_payment_attempt"?: { /** RFC3339 timestamp. Format: date-time. */ "completed_at"?: string; "expected_outstanding_money": MoneyValue; /** Reason code for an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.code. Unmapped values are returned as attempt_failed. */ "failure_code"?: "card_declined" | "insufficient_funds" | "bank_account_closed" | "bank_account_not_found" | "bank_debit_not_authorized" | "bank_account_restricted" | "bank_debit_limit_exceeded" | "authentication_required" | "payment_blocked" | "expired_card" | "incorrect_cvc" | "processing_error" | "payment_method_unavailable" | "payment_method_declined" | "payment_not_completed" | "payment_action_expired" | "payment_method_temporarily_unavailable" | "payment_failed" | "authorization_canceled" | "coupon_reservation_failed" | "invalid_payment_source" | "inventory_unavailable" | "order_changed_before_payment" | "order_payment_customer_mismatch" | "payment_attempt_canceled" | "payment_attempt_expired" | "payment_authorization_canceled" | "payment_authorization_expired" | "payment_confirmation_rejected" | "payment_confirm_outcome_unknown" | "payment_link_capacity_claim_failed" | "payment_link_capacity_validation_failed" | "payment_method_activation_pending" | "payment_method_required" | "payment_option_not_allowed" | "payment_option_unavailable" | "payment_source_binding_failed" | "payment_source_conflict" | "payment_source_not_updatable" | "payment_source_ownership_mismatch" | "receipt_email_failed" | "resource_guarantee_failed" | "setup_action_unavailable" | "setup_canceled" | "setup_cancellation_outcome_unknown" | "setup_cancellation_pending" | "setup_confirmation_outcome_unknown" | "setup_hold_acquisition_failed" | "setup_preparation_outcome_unknown" | "setup_processing" | "setup_result_incomplete" | "setup_status_unknown" | "tip_allocation_sync_failed" | "zero_balance_hold_acquisition_failed" | "attempt_failed" | (string & {}); /** Explanation of an attempt failure or interrupted payment step, when available. For payment declines, inspect each payment leg's last_payment_error.message. */ "failure_message"?: string; "gift_card_redemptions"?: Array<PaymentAttemptGiftCardRedemption>; /** Whether the attempt can continue through PayOrder with action: resume and this order_payment_attempt_id after any pending client action is complete. If false, check status before starting another payment; the attempt may still be in progress. */ "is_resumable": boolean; "mode": "payment" | "setup" | "settlement" | (string & {}); "order_payment_attempt_id": string; "payment_intents"?: Array<PaymentAttemptPaymentIntent>; "pending_actions"?: Array<PendingPaymentAction>; /** RFC3339 timestamp. Format: date-time. */ "started_at"?: string; "status": "processing" | "requires_action" | "requires_capture" | "partially_succeeded" | "requires_retry" | "finalizing" | "succeeded" | "failed" | "expired" | "canceled" | (string & {}); }; /** Contact the buyer entered in checkout before paying, saved with the session's checkout credential. Omitted until the buyer saves or clears a field. When a checkout session payment omits buyer_contact.email or buyer_contact.phone, Flint uses these values. Flint clears the contact 30 days after the session ends, and when a customer linked to the session is deleted. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared": boolean; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared": boolean; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: string; }; "checkout_session_id": string; /** The note supplied when the checkout session was closed. It is not shown to the buyer. */ "closed_reason"?: string; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "custom_text"?: CheckoutCustomTextWriteConfig; "customer"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id": string; "email": string; "name"?: string; "phone"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "customer_collection"?: CheckoutCustomerConfig; /** Contact and default addresses of the customer the checkout acts for: the customer the merchant created the session for, or the customer whose email the buyer confirmed in it. Present only on reads with the session's checkout credential while the session is open and acts for a customer. */ "customer_prefill"?: { /** The customer's default billing address. Omitted when the customer has none. */ "billing_address"?: { "city": string; /** ISO 3166-1 alpha-2 country code. minLength: 2. maxLength: 2. pattern: ^[A-Z]{2}$. Example: "US". */ "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; }; /** The customer's email. */ "email": string; /** The customer's default shipping address. Omitted when the customer has none. */ "shipping_address"?: { "city": string; /** ISO 3166-1 alpha-2 country code. minLength: 2. maxLength: 2. pattern: ^[A-Z]{2}$. Example: "US". */ "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; }; }; /** Immutable delivery method assignment captured when the checkout was created. */ "delivery_method_ids": Array<string>; /** Merchant-only immutable configuration lineage used to evaluate delivery quotes. */ "delivery_pinned_dependencies"?: Array<CheckoutDeliveryPinnedDependency>; /** Whether the order has at least one remaining quote-resolved fulfillment choice that must be selected before payment. */ "delivery_selection_required": boolean; "expiration"?: CheckoutExpirationConfig; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; /** Current fulfillment choices for Flint-owned pricing. Checkout credentials receive the fields available to buyers; merchant credentials also receive configuration lineage and diagnostics. External pricing reports requires_explicit_quote; reading this field does not request a delivery quote. Omitted when the session is not open, has no order, or Flint cannot read its delivery. */ "fulfillment"?: (({ "choice_groups": Array<DeliveryQuoteChoiceGroupResource>; "delivery_quote_id"?: string; "evaluation_status": "complete" | "incomplete" | "degraded" | "requires_explicit_quote" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Inputs the checkout's delivery methods need. Once the checkout has a delivery quote, these are the quote's input_requirements. Before that, they come from the methods alone and name no choice group: the fields in each method's quote_input_fields, and each recipient field a method requires. */ "input_requirements": Array<DeliveryInputRequirement>; "merchant_diagnostics": Array<DeliveryMerchantDiagnostic>; }) | ({ "buyer_reasons": Array<string>; "choice_groups": Array<BuyerDeliveryQuoteChoiceGroupResource>; "delivery_quote_id"?: string; "evaluation_status": "complete" | "incomplete" | "degraded" | "requires_explicit_quote" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: string; /** Inputs the checkout's delivery methods need. Once the checkout has a delivery quote, these are the quote's input_requirements. Before that, they come from the methods alone and name no choice group: the fields in each method's quote_input_fields, and each recipient field a method requires. */ "input_requirements": Array<BuyerDeliveryInputRequirementResource>; }) | (object)); "invoice"?: (({ "collection_block_status"?: "none" | "inventory_blocked" | "resolved" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id"?: string; /** RFC3339 timestamp. Format: date-time. */ "due_at"?: string; "invoice_id": string; "invoice_number"?: string; "is_overdue": boolean; "order_id"?: string; "outstanding_money": MoneyValue; "paid_money": MoneyValue; "refund_status"?: "none" | "partially_refunded" | "refunded" | (string & {}); "refunded_money": MoneyValue; "status": "draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "invoice_id"?: string; "legal"?: LegalSettings; "merchant_id"?: string; /** How the buyer can reach the merchant for help: the support email, phone, and URL the merchant set. Present only on reads with the session's checkout credential, and only when the merchant set at least one of them. Show it where your checkout tells the buyer to contact the merchant, such as an expired or closed checkout, or your receipt. */ "merchant_support"?: { /** Support email address. Format: email. */ "email"?: string; /** Support phone number. */ "phone"?: string; /** Support page, as an absolute http or https URL. Format: uri. */ "url"?: string; }; "metadata"?: Record<string, string>; "order"?: (({ /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "customer_id"?: string; "fulfillment_status"?: "not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled" | "not_applicable" | "closed" | (string & {}); "order_id": string; "order_number"?: string; "payment_intent_ids"?: Array<string>; "payment_status": "unpaid" | "partially_paid" | "paid" | (string & {}); "pricing_amounts": PricingAmounts; "refund_status": "none" | "partially_refunded" | "refunded" | (string & {}); "settlement_amounts": SettlementAmounts; "status": "open" | "closed" | (string & {}); /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; }) | (null)); "order_id"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription" | (string & {}); "payment_collection"?: { "stripe"?: PaymentCollectionStripe; }; "payment_intent_ids"?: Array<string>; "payment_intents"?: Array<ExpandedPaymentIntentSummary>; "payment_link"?: (({ /** Format: int32. */ "completed_count": number; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: string; "description"?: string; "name": string; "payment_link_id": string; "payment_link_type"?: "standard" | "donation" | "event" | (string & {}); "status": "active" | "inactive" | (string & {}); "subscription_plan_id"?: string; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; "url"?: string; }) | (null)); "payment_link_id"?: string; /** The card the buyer saved with this checkout's payment by giving a mobile phone number, and whether they confirmed it. Present only on reads with the session's checkout credential, after a payment that paid the order in full, or that was approved for the merchant to capture later, and saved a card this way. A checkout whose payment is approved stays open until the capture. */ "payment_method_save"?: { /** True while status is pending after the buyer confirmed the number by text, when the number alone can't save the card: the customer with the buyer's email existed before this payment, the buyer did not confirm that email in this checkout, and the number isn't already the customer's saved number with an active card saved with it. The buyer confirms the email with an emailed code to finish; the card is then saved with the number, which replaces the customer's saved number. */ "email_confirmation_required": boolean; /** When a pending save stops waiting: 24 hours after the payment succeeded or was approved. Format: date-time. */ "expires_at"?: string | null; /** Last two digits of the number the buyer gave, which a code is texted to. Set while status is pending. */ "phone_last_digits"?: string; "saved_with"?: "sms" | "email" | (string & {}); "status": "pending" | "saved" | "expired" | (string & {}); }; "payments"?: CheckoutPaymentConfig; /** Named conditions that affect checkout completion. Follow each problem's remediation action instead of reconstructing delivery lifecycle rules in the client. When Flint cannot read the checkout's delivery, the read still succeeds and reports delivery_selection_stale; its remediation says whether reading the session again can succeed, and its next action's reason_code names the error. */ "problems": Array<CheckoutProblemResource>; "promotion_config"?: CheckoutPromotionConfig; /** RFC3339 deadline for the restricted payment-attempt recovery window. Format: date-time. */ "recovery_expires_at"?: string | null; /** Whether this terminal session credential is temporarily restricted to recovering its owning payment attempt. */ "recovery_mode": boolean; /** Payment attempt that this checkout credential may recover while recovery_mode is true. */ "recovery_payment_attempt_id"?: string; "redirects"?: CheckoutRedirectsConfig; /** Whether checkout offers the buyer the option to save the card they type for faster checkout at this merchant. Present only on reads with the session's checkout credential. When true and save_payment_method_requires_verification is false, PayOrder accepts save_payment_method: true for one newly collected card. False when the merchant turned checkout.saved_payment_details off, customer accounts are merchant hosted, card is not an available payment option, the checkout collects an invoice, a subscription, or a return, or the checkout acts for no customer and Flint cannot email the buyer a verification code. */ "save_payment_method_offered"?: boolean; /** Whether the buyer can save the card they type by giving a US or Canadian mobile phone number with the payment, in save_payment_method_phone on POST /v1/orders/{order_id}/pay, and confirming it with a texted code after paying. Present only on reads with the session's checkout credential. True while Flint can send texts and either save_payment_method_requires_verification is true, so the number replaces confirming an email before paying, or the checkout acts for the customer whose email the buyer confirmed with this credential, so the number joins that customer's saved details once the buyer confirms it. */ "save_payment_method_phone_offered"?: boolean; /** Whether the buyer must confirm their email with a code before the checkout can save their card or use their saved cards. Present only on reads with the session's checkout credential. True when save_payment_method_offered is true and the checkout acts for no customer for this credential: the merchant created it without one, and either the buyer has not confirmed an email with this credential, or the customer whose email they confirmed has since changed that email or been deleted. A credential other than the one a confirmation returned, such as the hosted checkout link opened on another device, reads true. Send the code with POST /v1/checkout-sessions/{checkout_session_id}/customer-verifications. False while the checkout acts for a customer, and whenever save_payment_method_offered is false. */ "save_payment_method_requires_verification"?: boolean; "setup_collection"?: { "stripe"?: PaymentCollectionStripe; }; "status": "open" | "paid" | "partially_paid" | "expired" | "closed" | "invalidated" | (string & {}); "subscription_plan_id"?: string; /** Renewal terms a subscription checkout commits the buyer to. Frozen when the session's order was created, so later plan changes do not alter them. Absent when the checkout starts no subscription. */ "subscription_terms"?: { "billing_interval": "daily" | "weekly" | "monthly" | "yearly" | (string & {}); /** Number of billing intervals between recurring charges. Format: int32. */ "billing_interval_count": number; /** Minimum commitment in months, when the plan has one. Format: int32. */ "contract_term_months"?: number; /** Fee charged when the buyer cancels before the contract term ends, when the plan has one. */ "early_termination_fee_money"?: { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** Plan name shown to the buyer. */ "plan_name": string; /** Charge for one billing interval before tax: each line's unit price times its quantity, plus modifiers. */ "recurring_total_money": { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** One-time fee charged with the first payment, when the plan has one. */ "setup_fee_money"?: { /** Amount in the currency's minor unit, such as cents for USD. Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. */ "amount": string; /** ISO 4217 currency code for this amount. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". */ "currency": string; }; /** Flint subscription plan ID the terms come from. */ "subscription_plan_id": string; /** Days before the first recurring charge, when the plan has a trial. Format: int32. */ "trial_period_days"?: number; }; "superseding_checkout_session_id"?: string; "surface": "hosted" | "embedded" | (string & {}); "tax"?: CheckoutTaxConfig; "terminal_reason"?: "payment_succeeded" | "payment_partially_succeeded" | "expired" | "api" | "order_mutated" | "superseded" | "invoice_paid_elsewhere" | "invoice_voided" | "invoice_uncollectible" | "invoice_balance_changed" | (string & {}); "theme"?: ThemeConfig; "tip"?: CheckoutTipConfig; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: string; /** Hosted checkout URL that carries a one-time launch credential. Send the buyer here to pay. Returned for a hosted session on every launch result: create, payment-link resolve, and invoice and return-resolution checkout. Reads return it only to a credential that can manage checkout sessions. Omitted for embedded sessions. */ "url"?: string; };

package/declarations/CheckoutSessionInput.d.ts

@@ -10,4 +10,4 @@ import type { CheckoutTipConfigInput } from './CheckoutTipConfigInput.js';
 import type { LegalSettingsInput } from './LegalSettingsInput.js';
 import type { ThemeConfigInput } from './ThemeConfigInput.js';
 
-export type CheckoutSessionInput = { "active_payment_attempt"?: never; /** Contact the buyer entered in checkout before paying, saved with the session's checkout credential. Omitted until the buyer saves or clears a field. When a checkout session payment omits buyer_contact.email or buyer_contact.phone, Flint uses these values. Flint clears the contact 30 days after the session ends, and when a customer linked to the session is deleted. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared"?: never; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared"?: never; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: never; }; "checkout_session_id"?: never; /** The note supplied when the checkout session was closed. It is not shown to the buyer. */ "closed_reason"?: never; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: never; "custom_text"?: CheckoutCustomTextWriteConfigInput; "customer"?: never; "customer_collection"?: CheckoutCustomerConfigInput; /** Contact and default addresses of the customer the checkout acts for: the customer the merchant created the session for, or the customer whose email the buyer confirmed in it. Present only on reads with the session's checkout credential while the session is open and acts for a customer. */ "customer_prefill"?: never; /** Immutable delivery method assignment captured when the checkout was created. */ "delivery_method_ids": Array<string>; /** Merchant-only immutable configuration lineage used to evaluate delivery quotes. */ "delivery_pinned_dependencies"?: never; /** Whether the order has at least one remaining quote-resolved fulfillment choice that must be selected before payment. */ "delivery_selection_required"?: never; "expiration"?: CheckoutExpirationConfigInput; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: never; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; /** Current fulfillment choices for Flint-owned pricing. Checkout credentials receive the fields available to buyers; merchant credentials also receive configuration lineage and diagnostics. External pricing reports requires_explicit_quote; reading this field does not request a delivery quote. Omitted when the session is not open, has no order, or Flint cannot read its delivery. */ "fulfillment"?: never; "invoice"?: never; "invoice_id"?: never; "legal"?: LegalSettingsInput; "merchant_id"?: never; /** How the buyer can reach the merchant for help: the support email, phone, and URL the merchant set. Present only on reads with the session's checkout credential, and only when the merchant set at least one of them. Show it where your checkout tells the buyer to contact the merchant, such as an expired or closed checkout, or your receipt. */ "merchant_support"?: never; "metadata"?: Record<string, string>; "order"?: never; "order_id"?: string; "origin"?: never; "payment_collection"?: never; "payment_intent_ids"?: never; "payment_intents"?: never; "payment_link"?: never; "payment_link_id"?: never; /** The card the buyer saved with this checkout's payment by giving a mobile phone number, and whether they confirmed it. Present only on reads with the session's checkout credential, after a payment that paid the order in full, or that was approved for the merchant to capture later, and saved a card this way. A checkout whose payment is approved stays open until the capture. */ "payment_method_save"?: never; "payments"?: CheckoutPaymentConfigInput; /** Named conditions that affect checkout completion. Follow each problem's remediation action instead of reconstructing delivery lifecycle rules in the client. When Flint cannot read the checkout's delivery, the read still succeeds and reports delivery_selection_stale; its remediation says whether reading the session again can succeed, and its next action's reason_code names the error. */ "problems"?: never; "promotion_config"?: CheckoutPromotionConfigInput; /** RFC3339 deadline for the restricted payment-attempt recovery window. Format: date-time. */ "recovery_expires_at"?: never; /** Whether this terminal session credential is temporarily restricted to recovering its owning payment attempt. */ "recovery_mode"?: never; /** Payment attempt that this checkout credential may recover while recovery_mode is true. */ "recovery_payment_attempt_id"?: never; "redirects"?: CheckoutRedirectsConfigInput; /** Whether checkout offers the buyer the option to save the card they type for faster checkout at this merchant. Present only on reads with the session's checkout credential. When true and save_payment_method_requires_verification is false, PayOrder accepts save_payment_method: true for one newly collected card. False when the merchant turned checkout.saved_payment_details off, customer accounts are merchant hosted, card is not an available payment option, the checkout collects an invoice, a subscription, or a return, or the checkout acts for no customer and Flint cannot email the buyer a verification code. */ "save_payment_method_offered"?: never; /** Whether the buyer can save the card they type by giving a US or Canadian mobile phone number with the payment, in save_payment_method_phone on POST /v1/orders/{order_id}/pay, and confirming it with a texted code after paying. Present only on reads with the session's checkout credential. True while Flint can send texts and either save_payment_method_requires_verification is true, so the number replaces confirming an email before paying, or the checkout acts for the customer whose email the buyer confirmed with this credential, so the number joins that customer's saved details once the buyer confirms it. */ "save_payment_method_phone_offered"?: never; /** Whether the buyer must confirm their email with a code before the checkout can save their card or use their saved cards. Present only on reads with the session's checkout credential. True when save_payment_method_offered is true and the checkout acts for no customer for this credential: the merchant created it without one, and either the buyer has not confirmed an email with this credential, or the customer whose email they confirmed has since changed that email or been deleted. A credential other than the one a confirmation returned, such as the hosted checkout link opened on another device, reads true. Send the code with POST /v1/checkout-sessions/{checkout_session_id}/customer-verifications. False while the checkout acts for a customer, and whenever save_payment_method_offered is false. */ "save_payment_method_requires_verification"?: never; "setup_collection"?: never; "status"?: never; "subscription_plan_id"?: never; /** Renewal terms a subscription checkout commits the buyer to. Frozen when the session's order was created, so later plan changes do not alter them. Absent when the checkout starts no subscription. */ "subscription_terms"?: never; "superseding_checkout_session_id"?: never; "surface": "hosted" | "embedded"; "tax"?: CheckoutTaxConfigInput; "terminal_reason"?: never; "theme"?: ThemeConfigInput; "tip"?: CheckoutTipConfigInput; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: never; "url"?: never; };
+export type CheckoutSessionInput = { "active_payment_attempt"?: never; /** Contact the buyer entered in checkout before paying, saved with the session's checkout credential. Omitted until the buyer saves or clears a field. When a checkout session payment omits buyer_contact.email or buyer_contact.phone, Flint uses these values. Flint clears the contact 30 days after the session ends, and when a customer linked to the session is deleted. */ "buyer_contact"?: { /** Email supplied for the buyer, exactly as sent. Null when no email is saved; is_email_cleared distinguishes an explicit clear. Format: email. maxLength: 255. */ "email": string | null; /** True when the buyer explicitly cleared the email, including before entering one. Saving an email resets it to false. Do not restore a prefilled email while true. */ "is_email_cleared"?: never; /** True when the buyer explicitly cleared the phone, including before entering one. Saving a phone resets it to false. Do not restore a prefilled phone while true. */ "is_phone_cleared"?: never; /** Phone supplied for the buyer, in E.164 format. Null when no phone is saved; is_phone_cleared distinguishes an explicit clear. pattern: ^\+[1-9][0-9]{1,14}$. */ "phone": string | null; /** When the buyer last changed the saved checkout contact. Omitted on order buyer contact. Format: date-time. */ "updated_at"?: never; }; "checkout_session_id"?: never; /** The note supplied when the checkout session was closed. It is not shown to the buyer. */ "closed_reason"?: never; /** RFC3339 timestamp. Format: date-time. */ "created_at"?: never; "custom_text"?: CheckoutCustomTextWriteConfigInput; "customer"?: never; "customer_collection"?: CheckoutCustomerConfigInput; /** Contact and default addresses of the customer the checkout acts for: the customer the merchant created the session for, or the customer whose email the buyer confirmed in it. Present only on reads with the session's checkout credential while the session is open and acts for a customer. */ "customer_prefill"?: never; /** Immutable delivery method assignment captured when the checkout was created. */ "delivery_method_ids": Array<string>; /** Merchant-only immutable configuration lineage used to evaluate delivery quotes. */ "delivery_pinned_dependencies"?: never; /** Whether the order has at least one remaining quote-resolved fulfillment choice that must be selected before payment. */ "delivery_selection_required"?: never; "expiration"?: CheckoutExpirationConfigInput; /** RFC3339 timestamp. Format: date-time. */ "expires_at"?: never; /** Caller-owned identifier for this resource in an external system. maxLength: 255. */ "external_reference_id"?: string; /** Current fulfillment choices for Flint-owned pricing. Checkout credentials receive the fields available to buyers; merchant credentials also receive configuration lineage and diagnostics. External pricing reports requires_explicit_quote; reading this field does not request a delivery quote. Omitted when the session is not open, has no order, or Flint cannot read its delivery. */ "fulfillment"?: never; "invoice"?: never; "invoice_id"?: never; "legal"?: LegalSettingsInput; "merchant_id"?: never; /** How the buyer can reach the merchant for help: the support email, phone, and URL the merchant set. Present only on reads with the session's checkout credential, and only when the merchant set at least one of them. Show it where your checkout tells the buyer to contact the merchant, such as an expired or closed checkout, or your receipt. */ "merchant_support"?: never; "metadata"?: Record<string, string>; "order"?: never; "order_id"?: string; "origin"?: never; "payment_collection"?: never; "payment_intent_ids"?: never; "payment_intents"?: never; "payment_link"?: never; "payment_link_id"?: never; /** The card the buyer saved with this checkout's payment by giving a mobile phone number, and whether they confirmed it. Present only on reads with the session's checkout credential, after a payment that paid the order in full, or that was approved for the merchant to capture later, and saved a card this way. A checkout whose payment is approved stays open until the capture. */ "payment_method_save"?: never; "payments"?: CheckoutPaymentConfigInput; /** Named conditions that affect checkout completion. Follow each problem's remediation action instead of reconstructing delivery lifecycle rules in the client. When Flint cannot read the checkout's delivery, the read still succeeds and reports delivery_selection_stale; its remediation says whether reading the session again can succeed, and its next action's reason_code names the error. */ "problems"?: never; "promotion_config"?: CheckoutPromotionConfigInput; /** RFC3339 deadline for the restricted payment-attempt recovery window. Format: date-time. */ "recovery_expires_at"?: never; /** Whether this terminal session credential is temporarily restricted to recovering its owning payment attempt. */ "recovery_mode"?: never; /** Payment attempt that this checkout credential may recover while recovery_mode is true. */ "recovery_payment_attempt_id"?: never; "redirects"?: CheckoutRedirectsConfigInput; /** Whether checkout offers the buyer the option to save the card they type for faster checkout at this merchant. Present only on reads with the session's checkout credential. When true and save_payment_method_requires_verification is false, PayOrder accepts save_payment_method: true for one newly collected card. False when the merchant turned checkout.saved_payment_details off, customer accounts are merchant hosted, card is not an available payment option, the checkout collects an invoice, a subscription, or a return, or the checkout acts for no customer and Flint cannot email the buyer a verification code. */ "save_payment_method_offered"?: never; /** Whether the buyer can save the card they type by giving a US or Canadian mobile phone number with the payment, in save_payment_method_phone on POST /v1/orders/{order_id}/pay, and confirming it with a texted code after paying. Present only on reads with the session's checkout credential. True while Flint can send texts and either save_payment_method_requires_verification is true, so the number replaces confirming an email before paying, or the checkout acts for the customer whose email the buyer confirmed with this credential, so the number joins that customer's saved details once the buyer confirms it. */ "save_payment_method_phone_offered"?: never; /** Whether the buyer must confirm their email with a code before the checkout can save their card or use their saved cards. Present only on reads with the session's checkout credential. True when save_payment_method_offered is true and the checkout acts for no customer for this credential: the merchant created it without one, and either the buyer has not confirmed an email with this credential, or the customer whose email they confirmed has since changed that email or been deleted. A credential other than the one a confirmation returned, such as the hosted checkout link opened on another device, reads true. Send the code with POST /v1/checkout-sessions/{checkout_session_id}/customer-verifications. False while the checkout acts for a customer, and whenever save_payment_method_offered is false. */ "save_payment_method_requires_verification"?: never; "setup_collection"?: never; "status"?: never; "subscription_plan_id"?: never; /** Renewal terms a subscription checkout commits the buyer to. Frozen when the session's order was created, so later plan changes do not alter them. Absent when the checkout starts no subscription. */ "subscription_terms"?: never; "superseding_checkout_session_id"?: never; "surface": "hosted" | "embedded"; "tax"?: CheckoutTaxConfigInput; "terminal_reason"?: never; "theme"?: ThemeConfigInput; "tip"?: CheckoutTipConfigInput; /** RFC3339 timestamp. Format: date-time. */ "updated_at"?: never; /** Hosted checkout URL that carries a one-time launch credential. Send the buyer here to pay. Returned for a hosted session on every launch result: create, payment-link resolve, and invoice and return-resolution checkout. Reads return it only to a credential that can manage checkout sessions. Omitted for embedded sessions. */ "url"?: never; };

package/declarations/CheckoutSessionLaunchResult.d.ts

@@ -1,4 +1,5 @@
 
+import type { CheckoutAccess } from './CheckoutAccess.js';
 import type { CheckoutSession } from './CheckoutSession.js';
 
-/** Checkout-session access returned for hosted or embedded checkout creation. */ export type CheckoutSessionLaunchResult = { /** Checkout credential and, for hosted checkout, its launch URL. Keep the checkout credential on your backend. */ "checkout_access": { "checkout_auth_token": string; "hosted_url"?: string; }; "checkout_session": CheckoutSession; /** Deprecated. Use checkout_access. Present only for hosted checkout. */ "hosted_checkout"?: { /** Checkout-session auth token for clients that operate the created checkout session directly. The hosted URL uses a separate launch credential. */ "checkout_auth_token": string; /** Hosted checkout URL for the created or reused checkout session. */ "url": string; }; /** True when an existing checkout of the requested surface was reused. For POST /v1/checkout-sessions, true only when a retry with the original Idempotency-Key returns the session that request created. */ "reused_existing": boolean; };
+/** The checkout session and the credential to operate it. For hosted checkout, send the buyer to checkout_session.url. For embedded checkout, pass checkout_access.checkout_auth_token to your checkout client. */ export type CheckoutSessionLaunchResult = { "checkout_access": CheckoutAccess; "checkout_session": CheckoutSession; /** True when an existing checkout of the requested surface was reused. For POST /v1/checkout-sessions, true only when a retry with the original Idempotency-Key returns the session that request created. */ "reused_existing": boolean; };

package/declarations/CheckoutSessionLaunchResultInput.d.ts

@@ -1,4 +1,5 @@
 
+import type { CheckoutAccessInput } from './CheckoutAccessInput.js';
 import type { CheckoutSessionInput } from './CheckoutSessionInput.js';
 
-/** Checkout-session access returned for hosted or embedded checkout creation. */ export type CheckoutSessionLaunchResultInput = { /** Checkout credential and, for hosted checkout, its launch URL. Keep the checkout credential on your backend. */ "checkout_access": { "checkout_auth_token": string; "hosted_url"?: string; }; "checkout_session": CheckoutSessionInput; /** Deprecated. Use checkout_access. Present only for hosted checkout. */ "hosted_checkout"?: { /** Checkout-session auth token for clients that operate the created checkout session directly. The hosted URL uses a separate launch credential. */ "checkout_auth_token": string; /** Hosted checkout URL for the created or reused checkout session. */ "url": string; }; /** True when an existing checkout of the requested surface was reused. For POST /v1/checkout-sessions, true only when a retry with the original Idempotency-Key returns the session that request created. */ "reused_existing": boolean; };
+/** The checkout session and the credential to operate it. For hosted checkout, send the buyer to checkout_session.url. For embedded checkout, pass checkout_access.checkout_auth_token to your checkout client. */ export type CheckoutSessionLaunchResultInput = { "checkout_access": CheckoutAccessInput; "checkout_session": CheckoutSessionInput; /** True when an existing checkout of the requested surface was reused. For POST /v1/checkout-sessions, true only when a retry with the original Idempotency-Key returns the session that request created. */ "reused_existing": boolean; };