Managing Customers

A customer record in Odus represents a person or organization you charge. Each record holds contact information — name, email, phone number, and addresses — and links to that customer's payments, subscriptions, and saved payment methods. Creating a customer record lets you reuse it across multiple transactions instead of entering the same details each time.

Prerequisites

• A valid Odus secret key with CUSTOMER_UPDATE permission.

Create a customer

Send a POST /customers request. Only email is required.

{
  "email": "jane@example.com",
  "name": "Jane Smith"
}

The response includes the new customer's id (prefixed cus_). Use this id in payment and subscription requests to associate them with this customer.

You can also provide optional fields such as phoneNumber, dateOfBirth, billingAddress, shippingAddress, and metadata. See the POST /customers reference for the full parameter list.

Update a customer

Send a POST /customers/{id} request with the fields you want to change. All fields are optional — only the fields you include will be updated.

{
  "name": "Jane Doe",
  "phoneNumber": "+15559876543"
}

Updating metadata

The metadata field is merged with any existing metadata on every update. Only the keys you include are changed — existing keys that you do not mention are preserved. To remove a specific key, set its value to an empty string. To clear all metadata at once, send null.

{
  "metadata": {
    "internalAccountId": "acct_9870",
    "tier": "premium"
  }
}

note

Metadata is for your own use only. Odus does not use metadata values in any processing logic.

View a customer in the Dashboard

1. In the Dashboard, go to Customers.
2. Click a customer row to open the customer detail page.

The detail page shows:

• Subscriptions — all subscriptions linked to this customer.
• Payments — all payment attempts associated with this customer.
• Payment methods — saved cards and other payment methods stored for this customer.
• Customer details — contact information and editable metadata, displayed in the right sidebar.

To edit the customer's name, email, or address, click Edit on the customer card at the top of the page.

To edit metadata directly in the Dashboard, use the metadata editor in the Customer details sidebar and save your changes.

Find and filter customers

Dashboard

On the Customers list page, use the filter bar to narrow results:

Filter	Description
Email	Exact or partial match on email address
Name	Exact or partial match on display name
Created Date	Filter by creation date range

Click any row to open that customer's detail page.

API

Use GET /customers with query parameters to filter and paginate results. Filters support multiple operators: eq, ne, like, in, nin, and contains.

GET /customers?email[like]=example.com&sortDirection=DESC&page=1&pageSize=20

See Pagination, Filtering, and Sorting for the full list of supported filter fields and operators.