Backend API
Fields
Unique identifier for the customer.
Customer's email address.
Expandable list of saved addresses on file.
An object containing custom attribute key/value pairs.
Balance of customer credits.
Default customer billing information.
Expandable link to the customer's credit card on file, if applicable.
ID of the customer's credit card on file, if applicable.
Billing address line 1: street address/PO box/company name.
Billing address line 2: apartment/suite/unit/building.
Billing first name. If name is updated, then first_name will be automatically updated as the first word of the name.
Credit card billing details used when billing.method=card.
Token generated by Swell Checkout or Stripe.js.
When used with a payment gateway that performs address checks and address1 was provided. Can be pass, fail, unavailable, or unchecked.
Credit card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
Brand of the card displayed to the customer, if different from the underlying brand (for example, co-branded cards).
When used with a payment gateway that performs CVC code checks and cvc was provided. Can be pass, fail, unavailable, or unchecked.
Two-digit number representing the credit card expiration month.
Four-digit number representing the credit card expiration year.
ID of the payment gateway that should be used to process payments.
Last four digits of the card number.
Indicates this is a test card.
When used with a payment gateway that performs address checks and zip was provided. Can be pass, fail, unavailable, or unchecked.
Billing city/district/suburb/town/village.
Two-letter ISO country code.
Billing last name. If name is updated, then last_name will be automatically updated as the last words of the name.
Method of payment. Can be card, account or any one of the manual methods defined in payment settings.
Full name of the customer. If first_name or last_name are updated, then name will be automatically updated as a combination of first/last.
Billing phone number.
Billing state/county/province/region.
Billing zip/postal code.
Expandable list of saved credit cards on file.
Number of abandoned carts initiated by the customer.
Expandable list of carts created by the customer.
Expandable list of saved information for the primary contact on file for the account.
Expandable list of all contacts.
The ID of the primary contact.
Expandable list of customer credit transactions. Balance of these transactions is kept in balance.
Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
Date and time the customer was created.
Date the customer first abandoned a shopping cart.
Date the customer placed their first order.
Date the customer last abandoned a shopping cart.
Date the customer last logged into their account.
Date of the last order placed by the customer.
Date and time the customer was last updated.
Indicates the customer opted into email communications.
Customer's first name. If name is updated, then first_name will be automatically updated as the first word of the name.
Customer group used for special price rules and other customer logic.
Expandable list of invoices issued for the customer.
If name is updated, then last_name will be automatically updated as the last words of the name.
Customer’s preferred locale code.
Arbitrary data, typically set in a checkout flow to store custom values. See Frontend API for more details.
Full name of the customer. If first_name or last_name are updated, then name will be automatically updated as a combination of first/last.
Internal admin notes. These are not visible to the customer.
Expandable list of orders placed by the customer.
Number of orders the customer has placed over time.
Total value of all orders the customer has placed over time.
Password used to log in and gain access to sensitive information. When the customer has a password, they are required to log in when placing an order using the associated email address. This value is automatically encrypted using bcrypt.
If an account does not have a password defined, it is treated as a guest during checkout.
Unique key created when a customer requests a password reset.
When a customer requests password reset, an email is sent with this URL to redirect and authenticate the request.
A temp token generated by Swell, or a permanent password token assigned after submitting a temporary token (starting with password_).
Customer's phone number.
An array of strings, each representing a segment that the account belongs to. Segments are used to allow groups of customers access to particular coupons or promos.
Default customer shipping information.
Shipping full name. If first_name or last_name are updated, then name will be automatically updated as a combination of first and last.
Expandable link to the customer's address on file.
Setting this value will populate shipping with the associated customer's account address on file.
Shipping address line 1: street address/PO box/company name.
Shipping address line 2: apartment/suite/unit/building.
Shipping city/district/suburb/town/village.
Two-letter ISO country code.
Shipping first name. If name is updated, then first_name will be automatically updated as the first word of the name.
Shipping last name. If name is updated, then last_name will be automatically updated as the last words of the name.
Shipping phone number.
Shipping state/county/province/region.
Tax identification number of the recipient, where required for customs or delivery.
Shipping zip/postal code.
Indicates the customer has opted in to receive SMS marketing.
Expandable list of subscriptions held by the customer.
Type of customer. Can be one of individual or business.
Possible enum values:
Default VAT number for a business customer, if applicable.