get https://public.billsby.com/api/v1/rest/core//customers/
This query gets individual customer details using the unique identifier provided in the Billsby platform
This query gets a list of all the details held for individual customers in your account, including their personal details and details about their payment details on file. It doesn't return information on the customers subscriptions, for this you'll need to use the Get Customer subscriptions API.
Returned variables
Variable name | Description |
---|---|
companyCurrency | The currency that the company is billed in |
totalAmountPaid | The total amount the customer has paid so far for their subscription(s) |
averageAmountPerMonth | The average amount the customer pays per month for their subscription(s) |
cardStatus | The status of the card held on file: Valid Missing |
customerUniqueId | The unique identifier of the customer in the Billsby platform |
firstName | The customer's first name |
lastName | The customer's last name |
billingAddress | The customer's billing address |
The customer's registered email address | |
additionalEmail | Any additional email address held for the customer |
phoneNumber | The customer's phone number |
phoneNumberDialCode | The country code of the customer's phone number |
phoneNumberDialCountry | The registered country of the customer's phone number |
isMarketingConsentGiven | Does the product request marketing consent from the customer when it is added through Billsby Checkout: True False |
createdOn | The date on which the customer account was created |
status | The status of the customer: Active Inactive |