Customers (Onye)
Create a customer
Create a new customer record on the workspace.
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
Customer’s email address. Lowercased on save. Must be a valid email.
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.Up to 100 chars. Title-cased on save (
"ada" → "Ada").Up to 100 chars. Title-cased on save.
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 charsaddress2: 0–100 chars (pass""when not available)city: 1–50 charsstate: 1–50 charszip: 1–10 charscountry: exactly 2 chars (ISO-3166-1 alpha-2)
Free-form
{ string: string | null } map for tagging; for example,
a marketing source or internal segment.Response
Customer ID (
ony.…).Email address (lowercased).
Your reference.
First name (title-cased).
Last name (title-cased).
The address you provided.
Echo of metadata.
Customer status;
active for new records.ISO-8601 timestamp.

