These docs are for v2.0. Click to read the latest docs for v3.

All Customers API

Get all subscribers registered on recurpay

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Query Params

URL ParametersTypeDescription
limitintegerThe maximum number of results to show. Default - 100.

Response Params

AttributeTypeDescription
customersarray of objectsObject containing the customer details. See Customer - Object

Customer Object

AttributeTypeDescription
idstringCustomer id - A unique identifier for the customer.
emailstringThe unique email address of the customer.
first_namestringThe customer's first name.
last_namestringThe customer's last name.
phonestringThe customer's first name.
total_spentfloatThe customer's total spent on subscriptions.
notestringThe customer's profile note.
addressesobjectAll addresses linked to the customer. See Address - Object
default_addressobjectDefault address of the customer. See Address - Object
created_atdatetimeThe date and time when the customer was created.
updated_atdatetimeThe date and time when the customer was created.
channelstringChannel where the customer was created.

Address Object

AttributeTypeDescription
first_namestringThe customer's first name.
last_namestringThe customer's last name.
address1stringThe customer's mailing address.
citystringThe customer's city, town, or village.
provincestringThe customer's region name. Typically a province, a state, or a prefecture.
zipstringThe customer's postal code, also known as zip, postcode, Eircode, etc.
phonestringThe customer's phone.
phone_prefixstringThe prefix or international code of the phone.
phone_country_codestringThe country code of the phone number.
countrystringThe customer's country.
Query Params
string
Defaults to 1

The maximum number of results to show on a page

string
Defaults to [email protected]

Email of the specific customer

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json