Customers
End-customers of the Business
Retrieve a customer
Retrieve a customer
Create or update a customer
Upsert by ReferenceCustomer. If the reference already exists the customer is updated; otherwise a new customer is created.
List customers
List customers
Anonymize a customer
Anonymizes the customer's personal data (email, name). Used for GDPR erasure requests.
Revoke encrypted portal links
Revokes all active encrypted portal links. New links are generated on the next customer retrieval. Use this endpoint when a link may have been leaked or sent to the wrong customer, as the links can lead to sensitive information.
Invalidate a customer
Replaces the customer's ReferenceCustomer with a randomly generated identifier and revokes all its portal links.
Suspend a customer
Suspending a customer prevents access to the portal, hosted pages, and invoices. Use this endpoint only if a customer is fraudulent or presents a security risk, as this customer won't be able to re-subscribe again later.
Retrieve the billing address of a customer
Retrieve the billing address of a customer
Update the billing address of a customer
All fields are optional — only the provided fields are updated.
Retrieve the payment settings of a customer
Retrieve the payment settings of a customer
Update the payment settings of a customer
Updates the payment settings of a customer. All fields are optional — only the provided fields are updated. `TypePayment` on this endpoint can only be set to a manual payment method. Automated methods (`Card`, `DirectDebit`) are managed through the payment gateway.