Skip to main content
POST
Creates an onye (a customer) on the workspace that owns your secret key. Pass the resulting uid as onye when creating an ugwo to attach the payment to this customer.

Body parameters

string
required
Customer’s email address. Lowercased on save. Must be a valid email.
string
Your own reference (max 150 chars), typically a user ID in your system.Case-sensitive. "Id" and "id" are stored and looked up as distinct values.
string
Up to 100 chars. Title-cased on save ("ada""Ada").
string
Up to 100 chars. Title-cased on save.
object
Optional billing address. The object as a whole may be omitted, but when you provide it every field must be present. For a field you don’t have a value for (such as address2), pass an empty string ("") rather than omitting it. All fields are strings.
  • address: 1–100 chars
  • address2: 0–100 chars (pass "" when not available)
  • city: 1–50 chars
  • state: 1–50 chars
  • zip: 1–10 chars
  • country: exactly 2 chars (ISO-3166-1 alpha-2)
object
Free-form { string: string | null } map for tagging; for example, a marketing source or internal segment.

Response

string
Customer ID (ony.…).
string
Email address (lowercased).
string | null
Your reference.
string | null
First name (title-cased).
string | null
Last name (title-cased).
object | null
The address you provided.
object
Echo of metadata.
string
Customer status; active for new records.
string
ISO-8601 timestamp.