Interface BillingDetailsCollectionConfiguration

Controls how billing details are collected during checkout.

Checkout Session Private Preview

interface BillingDetailsCollectionConfiguration {
    name?: "automatic" | "always";
    phone?: "automatic" | "always";
    address?: "automatic" | "full";
    attachDefaultsToPaymentMethod?: boolean;
}

Properties

name? phone? address? attachDefaultsToPaymentMethod?

Properties

Optionalname

name?: "automatic" | "always"

How to collect the name field. Defaults to automatic.

Optionalphone

phone?: "automatic" | "always"

How to collect the phone field. Defaults to automatic.

Optionaladdress

address?: "automatic" | "full"

How to collect the billing address. Defaults to automatic.

OptionalattachDefaultsToPaymentMethod

attachDefaultsToPaymentMethod?: boolean

Whether default billing details are attached to the payment method.

Settings

Member Visibility

On This Page

Properties