put https://public.billsby.com/api/v1/rest/core//customers//gdprcleanup
The clear customer data API may be used to remove any personal information we hold on your customers, without deleting them. Due to GDPR we're required to remove a customers data from our database at their request and so this allows you to do so, without having to delete all of their past subscription data.
This is useful because by keeping your customers subscription data, you'll be able to include them in your reporting statistics to get a more accurate overview of your company's performance and statistics.
The returned values fo this API should show "gdpr" in place of all personal details held for the customer.
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 |
| customerTaxRegNumber | The customers alphanumeric tax registration number |
| customerUniqueId | The unique alphanumeric 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 |
| phoneNumberDialCountry | The registered country of the customer's phone number |
| phoneNumberDialCode | The country code of the customer's phone number |
| phoneNumber | The customer's phone number |
| isMarketingConesentGiven | 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 |