Get customer
GET https://api.ecurring.com/customers/{id}
Retrieve a single customer by it's identifier.
Parameters
Replace {id}
in the URL with the identifier of the customer.
include
string |
Optional - A comma seperated list of relationships to include in the response. Possible values: subscriptions
|
fields[TYPE]
string |
Optional - A comma seperated list of fields to return as data properties in the response. Known as Sparse Fieldsets.
Replace TYPE with the name of the resource.
|
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Data attributes
gender
string |
Optional - The gender of the customer. Used to determine the salutation in communication with the customer.
Possible values: m / f
|
first_name
string |
The first name of the customer |
middle_name
string |
Optional - The middle name of the customer |
last_name
string |
The last name of the customer |
company_name
string |
Optional - The name of the company of the customer |
vat_number
string |
Optional - The vat number of the company of the customer |
bank_holder
string |
Optional - DEPRECATED: The full name of the bank account holder (this can be different from the name of the customer). Only available when manually entered when creating the customer (either through the API, the admin interface or the subscription form). This field will be empty when the "online payment" mandate method is used. |
iban
string |
Optional - DEPRECATED: The IBAN of the customer Only available when manually entered when creating the customer (either through the API, the admin interface or the subscription form). This field will be empty when the "online payment" mandate method is used. |
payment_method
string |
The payment method used to collect the funds from the customer. Possible values: directdebit , creditcard .
By default this is set to directdebit until the customer completes a first payment via creditcard.
|
bank_verification_method
string |
Optional - The method used used by the customer to validate their bankaccount or creditcard. Possible values: creditcard , mistercash , ideal , kbc , belfius .
Empty when IBAN is manually supplied.
|
card_holder
string |
The name of the holder of the bank account or creditcard. Replaces the deprecated bank_holder . Empty until a first payment is made or when the bank_holder is supplied during creation.
|
card_number
string |
The last 4 digits of the bank account or creditcard of the client. Replaces the deprecated IBAN . Empty until a first payment is made or when the IBAN is supplied during creation.
|
postalcode
string |
Optional - The postalcode of the address of the customer |
house_number
string |
Optional - The house number of the address of the customer |
house_number_add
string |
Optional - The house number addition of the address of the customer |
street
string |
Optional - The street of the address of the customer |
city
string |
Optional - The city of the address of the customer |
country_iso2
string |
Optional - The 2 letter ISO code of the country of residence of the customer |
language
string |
The preferred communication language of the customer. Any notifications sent to the customer will be in this language.
Possible values: nl , en , nl-be , de , fr .
|
email
string |
The email address of the customer |
telephone
string |
Optional - The telephone number of the customer |
archived
boolean |
Optional - Archived state of the customer. |
created_at
datetime |
The date on which the customer was created |
updated_at
datetime |
The date on which the customer was last updated |
Relationships
subscriptions
subscription |
The subscriptions of the customers |
Example
{
"links": {
"self": "https://api.ecurring.com/customers/1"
},
"data": {
"type": "customer",
"id": "1",
"links": {
"self": "https://api.ecurring.com/customers/1"
},
"attributes": {
"gender": "m",
"first_name": "Jeroen",
"middle_name": null,
"last_name": "van der Geer",
"company_name": null,
"vat_number": null,
"bank_holder": null,
"iban": null,
"payment_method": "directdebit",
"bank_verification_method": null,
"card_holder": "J van der Geer",
"card_number": "6789",
"postalcode": "1016EE",
"house_number": "313",
"house_number_add": "",
"street": "Keizersgracht",
"city": "Amsterdam",
"country_iso2": "NL",
"language": "nl",
"email": "support@ecurring.com",
"telephone": "+31202616739",
"archived": false,
"created_at": "2018-02-01T11:21:09+01:00",
"updated_at": "2018-02-01T11:21:09+01:00"
},
"relationships": {
"subscriptions": {
"links": {
"related": "https://api.ecurring.com/customers/1/subscriptions"
},
"data": [
{
"type": "subscription",
"id": "1"
}
]
}
}
}
}