Customer Structure

Base Attributes

Attribute Type Example

id

The ID of the customer

 String cus_1CG7FcsBBTH78JEDjfNBuL

name

The name of the customer

 String Acme Inc

invoice_reference

The customer's invoice reference

 String 1000003

default_gocardless_mandate

The ID of the customer's usable GoCardless mandate, if one is set up

 String gcm_1CGLPzDrTJvogmcRvTsUox

address.line1

The first line of the customer's address

 String 1 Example Street

address.line2

The second line of the customer's address

 String

address.line3

The third line of the customer's address

 String

address.line4

The fourth line of the customer's address

 String

postcode

The customer's postcode

 String AB1 2CD

vat_number

The customer's VAT number

 String

vat_rate

The VAT rate applied to this customer

 Decimal 20.0

auto_payments

Whether payments are automatically collected for this customer

 Boolean true

created_at

The time the customer was created, as a Unix timestamp in seconds

 Integer 1758986220

updated_at

The time the customer was updated, as a Unix timestamp in seconds

 Integer 1758986220

Expansions

Expansions are embedded structures of other objects that are related to the structure that you're viewing. Which expansions are returned by a specific action are shown on that action's documentation however some actions allow you to choose which expansions are returned.

Attribute Type Example

default_gocardless_mandate

The customer's usable GoCardless mandate, if one is set up

 Hash Gocardless mandate structure

reseller

The reseller that this customer belongs to

  • Must be authenticated as an admin.
 Hash Reseller structure