List customers

GET https://api.ecurring.com/customers

In order to add a new subscription to a customer you will require the id of a customer.

This endpoint allows you to retrieve all of the customers in your account.

Parameters

page[number]
integer
Optional - The number of the page (default is 1)
page[size]
integer
Optional - The number of objects to return (default is 10)
include
string
Optional - A comma seperated list of relationships to include in the response. Possible values: subscriptions

Response

meta
object
An object containing some meta information about the response.
total
integer
The total number of objects in the response
links
object
Links to help navigate through the lists of objects, based on the given page number and page size.
self string The current page
first string Optional - The first page of the set
last string Optional - The last page of the set
prev string Optional - The previous page in the set
next string Optional - The next page in the set
data
object
A list of customer objects as described in Get customer

Example

Request

GET /customers HTTP/1.1
X-Authorization: 53b9e049186e04743bcdd685ea0bafbd1ff9e0c7f

Response

{
  "meta": {
    "total": 10
  },
  "links": {
    "self": "https://api.ecurring.com/customers?page[number]=1&page[size]=10",
    "first": "https://api.ecurring.com/customers?page[number]=1&page[size]=10",
    "last": "https://api.ecurring.com/customers?page[number]=18&page[size]=10",
    "prev": null,
    "next": "https://api.ecurring.com/customers?page[number]=2&page[size]=10"
  },
  "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": "J van der Geer",
          "iban": "NL66ECUR0123456789",
          "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": "jvdgeer@example.com",
          "telephone": "+31202616739",
          "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"
              }
            ]
          }
        }
    },
    { ... }
  ]
}