Customers
Create and manage customers shared across products.
Customers store a buyer's identity and default payment details. A single customer record is shared across payments, subscriptions, invoices, and loyalty — attach a payment method once and reference the customer everywhere.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The customer objectAsk
idstringUnique identifier for the customer, e.g. cust_8aZ2.
emailstringThe customer's email address.
namestringThe customer's full name.
phonestringThe customer's phone number in E.164 format, e.g. +14155552671.
default_payment_methodobjectExpandableThe default payment method for this customer. Expand to retrieve the full object.
createdintegerUnix timestamp when the customer was created.
Create a customerAsk
Pass an email and optional name and phone. VINR returns a customer object you can attach payment methods to and reference on future payments and subscriptions.
Retrieve a customerAsk
Update a customerAsk
Send any subset of fields — only the fields you pass are changed.
Delete a customerAsk
Deletes the customer and unlinks them from future charges. Active subscriptions must be canceled first.
List customersAsk
Returns a paginated list of customers. Filter by email to look up a specific buyer.
Related eventsAsk
customer.created, customer.updated, customer.deleted. See Events.
