The Customer object

An onye is a customer record on your workspace. Customers are optional: you can create an ugwo with just onye_email and Kwugwo will find or create the customer for you. Create them explicitly when you want to attach your own user ID, names or billing address.

Attributes

string

Unique identifier, ony.XXXX.YYYYYYYYYYYYYYYYYYYYYYYY.

string

Email address, lowercased. Unique per workspace.

string | null

First name, title-cased (ada → Ada).

string | null

Last name, title-cased.

string | null

Your reference for this customer, typically your user ID. You set it as ref on create and update; it is returned as nzube_ref. Case-sensitive.

object | null

Show properties

string

Street address.

string

Second line; "" when unused.

string

City.

string

State or region.

string

Postal code.

string

ISO-3166-1 alpha-2 code, e.g. NG.

string

ISO-8601 timestamp.

string

ISO-8601 timestamp.

object

Your { "key": "value" } metadata. {} when there is none.

integer

Number of successful payment attempts by this customer.

integer

Number of failed payment attempts by this customer.

string | object | null

The customer’s most recent activity. On Get a customer this is the full Activity object; everywhere else (list, create, update, delete, nested in an ugwo, and webhooks) it is just the activity ID, act.…. null if the customer has never paid.

The Customer object

{
  "uid": "ony.VCvr.7K2qPmRtV9xLnQ8sD1cYwHfE",
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Okeke",
  "nzube_ref": "user_8821",
  "billing_address": {
    "address": "12 Marina",
    "address2": "",
    "city": "Lagos",
    "state": "Lagos",
    "zip": "101001",
    "country": "NG"
  },
  "created_at": "2026-05-15T09:14:22+00:00",
  "updated_at": "2026-05-15T09:14:22+00:00",
  "meta": { "source": "shopify" },
  "total_successful_activities": 3,
  "total_failed_activities": 1,
  "latest_ugwo_activity": "act.VCvr.qnbBJaElzSTHOcaTzxbuDlIs"
}

Get started

Plugins

Guides

Concepts

API basics

Payments (Ugwo)

Activities

Next actions

Refunds

Customers (Onye)

Checkouts

Attributes

​Attributes

Attributes