Manage customers

Customers are the accounts people hold on your storefront. Most customers register themselves, but you can also create one, correct their details, add credit to their balance or close their account from the organization's Customers tab. The same tab holds the custom fields you store on customers and services, and your OAuth clients.

• Any member can see customers. Creating, editing and closing them takes the owner or admin role, and adding credit takes the billing role or higher.
• A customer account belongs to your organization only. It is separate from any Coritan account, even one with the same email.

1. In the dashboard, open the organization, then the Customers tab.
2. Type in Search customers to match a name, email, public handle, company or customer number, or choose a status in the list next to it.
3. Select a customer to open their details.

The details show the account's status and badges such as Email verified, Staff account for a member's own account and Social sign-in only for an account with no password. Below them are the Credit balance, Currency, Country, Last sign-in and any custom fields. View services and View invoices open those tabs filtered to the customer.

1. On the Customers tab, select New customer.
2. Enter their Email and a Password of at least 8 characters.
3. Add a First name, Last name, Company and Phone if you have them.
4. Leave Preferred currency empty to use the default for their country, or enter a three-letter code such as EUR.
5. Select Create customer.

The customer can sign in on your storefront straight away, and receives your organization's welcome email. Your webhooks receive customer.created.

1. Open the customer and select Edit.
2. Change the Email, names, Company, Phone, Status or Currency. A new currency applies to the whole account.
3. Select Save changes.

When you change the email, the old address receives a message about the change. Setting Status to Suspended or Closed stops the customer's sessions working at once and cancels any open invitations to share a server with them.

1. Open the customer. The credit form is under their details.
2. Enter an Amount above zero and a Description, which appears on their credit history.
3. Select Add credit.

The dashboard confirms the new balance. The customer can pay invoices with it, and an invoice paid from credit is not part of a payout.

1. Open the customer and select Delete.
2. Type the customer's email to confirm, then select Delete customer.

Custom fields hold extra facts about a customer or a service, such as a VAT number.

1. On the Customers tab, in Custom fields, select New field.
2. Enter a Label, such as VAT number, and a Key, such as vat_number. The key starts with a letter, uses lowercase letters, digits and underscores, and cannot be changed later.
3. Choose a Type and whether it Applies to a Customer or a Service.
4. Add a Default value and tick Required if you need them.
5. Select Add field.

When you or your storefront send custom field values for a customer, the API refuses a key that is not defined (Unknown custom field 'vat') and a missing required one (Required custom field 'vat_number' is missing). To delete a field, select the bin icon on its row and type its key. The values already stored on customers and services are deleted with it.

The OAuth clients card, visible to owners and admins, registers an application with its Name, Redirect URIs (full http or https addresses, one per line), Allowed scopes and Grant types. Select New client, fill them in and select Create client. The client secret is shown once, so copy it before you close the dialog.

Email already registered in this organization

Another customer of your organization has that email. Search for them instead.

Customer limit reached (100/100)

Your organization holds as many customers as Coritan allows it. Close accounts you no longer need, or ask support to raise the limit.

Currency GBP is not enabled

Coritan does not take payment in that currency. Leave the currency empty or choose another.

Amount must be positive

Enter an amount above zero.

• Manage customer services
• Manage customer invoices
• Sign customers in to your storefront
• Look after customers in the staff console

List customers, newest first. q searches, status_filter takes active, suspended, closed or banned, and limit (1–200, default 50) and offset page the list. Add with_total=true for {items, total, limit, offset, counts}, where counts gives the number of customers in each status for the same search.

curl "https://api.coritan.com/api/v1/orgs/acme/customers?q=alex&with_total=true" \
  -H "Authorization: Bearer $CORITAN_TOKEN"

Create a customer with email and password (at least 8 characters), and optionally first_name, last_name, company, phone, currency and custom_fields:

curl -X POST https://api.coritan.com/api/v1/orgs/acme/customers \
  -H "Authorization: Bearer $CORITAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email": "alex@example.com", "password": "a-long-passphrase", "first_name": "Alex", "currency": "EUR"}'

Read one with GET /customers/{customer_id}, and change it with PATCH on the same path and any of the fields above plus status. DELETE /customers/{customer_id} closes the account and answers {"message": "Customer deactivated"}.

Add credit with the amount and the description as query parameters. The answer is the new balance:

curl -X POST "https://api.coritan.com/api/v1/orgs/acme/customers/812/credit/add?amount=10.00&description=Goodwill" \
  -H "Authorization: Bearer $CORITAN_TOKEN"

{"credit_balance": 25.0}

Custom fields are GET /custom-fields (filter with applies_to), POST /custom-fields with field_name, label, field_type, applies_to (customer, service or product), options, default_value and required, and DELETE /custom-fields/{field_id}. OAuth clients are GET /oauth-clients and POST /oauth-clients with name, redirect_uris, allowed_scopes and grant_types; the answer carries client_secret once.