GuidesDiscussions
API Reference
Start typing to search…

Customer objects

Overview

The endpoints in this section return one of the objects described below.

📘

To learn about customers in the Inspire API, read About customers.

Properties of the customer object

The List customers, Create customer, and Update customer endpoints return Customer objects with the following properties:

  • id (String): Customer ID.
  • email (String): Contact email address.
  • name (String): Customer Name.
  • createdDate (String): Date and time when the customer was created.
  • metadata (Object Array): Array containing custom settings stored as key-value pairs.
  • getCurrency (Object): Object describing the default currency for this customer.
  • totalSpent (String): Total spent by this customer for this tenant.
  • paymentMethod (Object): Object descibing the customer's payment method.
  • coupon (Object): Object describing the customer's default coupon.

Properties of the customer details object

The Get customer details endpoint returns an object with these properties:

  • id (String): Customer ID.
  • email (String): Contact email address.
  • name (String): Customer's full name.
  • getCurrency (Object): Object describing the default currency for this customer.
  • totalSpent (String): Total spent by this customer for this tenant.
  • totalDisputed (Number): The total ammount of all disputed transactions.
  • nextInvoiceSequence (Number)
  • billingUseCustomerEmail (Boolean)
  • description (String): Customer's description.
  • invoicePrefix (String): Invoice prefix.
  • country (Object): Object describing the customer's country of residence.
  • billingCountry (Object): Object describing the customer's billing country.
  • billingPhoneCountry (Object): Object describing the customer's billing phone country.
  • billingEmail (String): Billing email address.
  • billingEmailCc (String): Billing email CC.
  • billingPhone (String): Billing phone.
  • billingAddress1 (String): Billing address line 1.
  • billingAddress2 (String): Billing address line 2.
  • billingPostalCode (String): Billing postal code.
  • billingState (String): Billing state.
  • billingStreetNumber (String): Billing street number.
  • billingCity (String): Billing city.
  • shippingName (String): Shipping address name.
  • shippingStreetNumber (String): Shipping street number.
  • shippingAddress1 (String): Shipping address line 1.
  • shippingAddress2 (String): Shipping address line 2.
  • shippingCity (String): Shipping city.
  • shippingState (String): Shipping state.
  • shippingStateId (String): Shipping state ID.
  • shippingPostalCode (String): Shipping postal code.
  • shippingPhone (String): Shipping phone number.
  • shippingUseBillingAddress (Boolean): If True, the shipping address is the same as the billing address.
  • shippingNeighborhood (String): Shipping neighborhood.
  • shippingCountry (Object): Object describing the customer's shipping country.
  • shippingPhoneCountry (Object): Object describing the customer's shipping phone country.
  • metadata (array): Array of key-value pairs to store custom properties.
  • updatedDate (String): Date and time when the customer was updated.
  • createdDate (String): Date and time when the customer was created.
  • deletedDate (String): Date and time when the customer was deleted.
  • top100 (Boolean): Is this cutomer in the top 100?
  • coupon (Object): Object describing the customer's default coupon.
  • timezoneId (String): Time zone ID.
  • languageId (String): Language ID.
  • currencyId (String): Currency ID.
  • countryId (String): Country ID.