Customer Properties |
The GoCardlessCustomer type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | address_line1 |
The first line of the customer’s address.
|
| address_line2 |
The second line of the customer’s address.
|
| address_line3 |
The third line of the customer’s address.
|
| city |
The city of the customer’s address.
|
| company_name |
Customer’s company name. Required unless a given_name and family_name are provided.
|
| country_code |
ISO 3166-1 alpha-2 code.
|
| created_at |
Fixed timestamp, recording when this resource was created.
|
|
Customer’s email address.
| |
| family_name |
Customer’s surname. Required unless a company_name is provided.
|
| given_name |
Customer’s first name. Required unless a company_name is provided.
|
| id |
Unique identifier, beginning with “CU”.
|
| IDEMPOTENCYKEY |
Not part of actual object sent to GoCardless. Used in HTTP header to prevent duplicating a successful request.
|
| language |
ISO 639-1 code. Used as the language for notification emails sent by GoCardless if your organisation does not send its own (see compliance requirements). Currently only “en”, “fr”, “de”, “pt”, “es”, “it”, “nl”, “sv” are supported. If this is not provided, the language will be chosen based on the country_code (if supplied) or default to “en”.
|
| metadata |
Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
|
| postal_code |
The customer’s postal code.
|
| region |
The customer’s address region, county or department.
|
| swedish_identity_number |
IS NOT USED.
For Swedish customers only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer’s bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
Beta: this field is only used for Autogiro, which is currently in beta.
|
See Also