Customers and agreements
Customers

Customers

Customers are the businesses or individuals subscribing to or purchasing your services and products.

Customer example

Creating a customer

When adding a customer on Proper, we require the following information:

  • Legal name
  • Address
  • Legal Entity
  • Tax ID (if applicable)

For the legal entity, you can select if your customer is an individual or a company. Public institutions are also considered companies. The Tax ID is only required if the legal entity is set to company.

It's also possible to specify invoice settings including custom data fields that are specific for your customer. Examples might be purchase order (PO) numbers, buyer references, or contractor numbers. These will then be stated in the header of all invoices going to this customer (if not overwritten by the agreement details). You may also add metadata on the customer to store information for internal reference. These will never be displayed to your customers.

To add a customer through the API, use the following API call. This step is essential before setting up agreements or subscriptions for the customer.

curl --request POST \
--url https://api.properpayments.io/customers \
--header 'Authorization: YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"name": "Customer full name",
"address": {
"line1": "Amalienborg Slotsplads 5",
"postalCode": 1257,
"city": "København K",
"country": "DK"
},
"vatId": 12345678,
"invoiceSettings": {
  "customFields": {
    "PO": 123
  }
},
"legalEntity": "Company"
}'

Proper does obligatory compliance checks (KYC) on all your customers ensuring that is safe to handle payments. This is a requirement from our regulators and is intended to prevent abuse of the financial system.

Updating a customer

When updating a customer through the API, the old information will be overwritten with the provided data. If the custom fields should be extended and not replaced, the new fields need to be provided along with the previous information.

WebhooksAgreements