v1
latestOpenAPI 3.1.02026-07-26580123.9 KBCustomer details
This query gets individual customer details using the unique identifier provided in the Billsby platform
get/{companyDomain}/customers/{customerUniqueId}
Path parameters
companyDomainstring required
Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets
customerUniqueIdstring required
The unique identifier of the customer in the Billsby platform
Response
200
Example response
{
"companyCurrency": "string",
"totalAmountPaid": "440",
"averageAmountPerMonth": "20",
"cardStatus": "active",
"customerUniqueId": "6ZY37ULDEF",
"firstName": "Mary",
"lastName": "quinn",
"billingAddress": {
"addressLine1": "20 Woodfood Road",
"addressLine2": "Saltdean",
"state": "Brighton",
"city": "Brighton",
"country": "England",
"postCode": "BN3 4GH"
},
"email": "mary.quinn@mistimail.com",
"additionalEmail": "marymay@mistimail.com",
"phoneNumberDialCountry": "england",
"phoneNumberDialCode": "+1",
"phoneNumber": "07822839281",
"isMarketingConsentGiven": true,
"createdOn": "2020-04-29T10:16:25.474Z",
"status": "active"
}