Skip to main content
Customers are the people and businesses you invoice and make payment links for. They’re your own records: nothing about a customer is sent to a payment network, so you can add them before your account is verified. Scopes: customers:read, customers:write.

Create a customer

name and email are required. You can also add up to five additionalEmails (copied on invoices), a phone and an address. Emails are stored in lower case.

Update a customer

PATCH /v1/customers/{id} changes only the fields you send. Send null to clear phone or address.

Delete a customer

DELETE /v1/customers/{id} removes the customer from your list. Payment links and invoices you made for them still show who they were for.

Use customers

  • Invoices are issued to a customer: see Invoices.
  • Payment links can name a customer with customerId, for your records: see Payment links.