The Customer object represents your users and is a core resource within Yorlet. You can use it to store profile and legal information, as well as collecting Payment Methods and setting up Subscriptions.

Create a customer

Include the following code on your server to create a new customer.

curl https://api.yorlet.com/v1/customers \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
        "email": "[email protected]"
      }'

See the create a customer API for a full list of parameters you can send.

Customer profile

At the least, you must provide a valid email address for the customer to create a Customer object. The email will be used to send notifications of past due invoices and payment receipts.

We also recommed storing your applciations internal reference to your customer within the metadata attribute.