id string

Unique identifier for the object. Zoneless customer IDs are prefixed with cus_z_.

addressnullable object

The customer's address.

balance number

The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Zoneless hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see invoice_credit_balance.

created timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

currencynullable string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

Difference from Stripe: Zoneless only settles in usdc, so this field is either null or usdc.

default_sourcenullable string Expandable This can be expanded into an object with the expand request parameter.

ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

Difference from Stripe: Stripe's default source is a bank account or card ID. Zoneless's default source is a linked Solana wallet ID (src_z_ prefix).

delinquentnullable boolean

Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API sets this field to false. An automatic payment failure or passing the invoice's due_date sets this field to true.

descriptionnullable string

An arbitrary string attached to the object. Often useful for displaying to users.

discountnullable object

Describes the current discount active on the customer, if there is one.

emailnullable string

The customer's email address.

invoice_prefixnullable string

The prefix for the customer used to generate unique invoice numbers.

invoice_settings object

The customer's default invoice settings.

metadata object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

namenullable string

The customer's full name or business name.

next_invoice_sequencenullable number

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field is omitted in API responses.

phonenullable string

The customer's phone number.

preferred_localesnullable array of strings

The customer's preferred locales (languages), ordered by preference.

shippingnullable object

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

sourcesnullable object

The customer's payment sources, if any.

Difference from Stripe: Zoneless customers pay from linked Solana wallets rather than bank accounts, so each item in sources.data represents a wallet rather than a bank account. See External Wallets for the equivalent object sellers use to receive USDC payouts.

subscriptionsnullable object

The customer's current subscriptions, if any.

tax_exemptnullable enum

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text "Reverse charge".

tax_idsnullable object

The customer's tax IDs.

test_clocknullable string

ID of the test clock that this customer belongs to.

address object

The customer's address. Recommended if you plan to calculate tax for this customer.

balance integer

An integer amount in the smallest currency unit that represents the customer's current balance, which affects the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. For USDC, this is cents (e.g., 100 = $1 USDC).

description string

An arbitrary string that you can attach to a customer object. It's displayed alongside the customer in the dashboard.

email string

Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. The maximum length is 512 characters.

invoice_prefix string

The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.

invoice_settings object

Default invoice settings for this customer.

metadata object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

name string

The customer's full name or business name. The maximum length is 256 characters.

next_invoice_sequence integer

The sequence to be used on the customer's next invoice. Defaults to 1.

payment_method string

The ID of the payment method to attach to the customer.

phone string

The customer's phone number. The maximum length is 20 characters.

preferred_locales array of strings

Customer's preferred languages, ordered by preference.

shipping object

The customer's shipping information. Appears on invoices emailed to this customer.

tax_exempt enum

The customer's tax exemption. One of none, exempt, or reverse.

address object

The customer's address. Recommended if you plan to calculate tax for this customer.

balance integer

An integer amount in the smallest currency unit that represents the customer's current balance, which affects the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.

default_source string

If you're using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method parameter instead.

Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.

If you want to add a new payment source and make it the default, see the source property. The maximum length is 500 characters.

description string

An arbitrary string that you can attach to a customer object. It's displayed alongside the customer in the dashboard.

email string

Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. The maximum length is 512 characters.

invoice_prefix string

The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.

invoice_settings object

Default invoice settings for this customer.

metadata object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

name string

The customer's full name or business name. The maximum length is 256 characters.

next_invoice_sequence integer

The sequence to be used on the customer's next invoice. Defaults to 1.

phone string

The customer's phone number. The maximum length is 20 characters.

preferred_locales array of strings

Customer's preferred languages, ordered by preference.

shipping object

The customer's shipping information. Appears on invoices emailed to this customer.

tax_exempt enum

The customer's tax exemption. One of none, exempt, or reverse.

email string

A case-sensitive filter on the list based on the customer's email field. The value must be a string. The maximum length is 512 characters.

test_clock string

Provides a list of customers that are associated with the specified test clock. The response won't include customers with test clocks if this parameter isn't set.