Skip to main content

Customer

Also the standalone Customer entity. The entity-only fields below are null on the copy embedded in a charge or a subscription: that copy is a snapshot taken at payment time and is never rewritten when the customer is later edited. Use customerId to reach the live entity.

type Customer {
id: ID
email: String
name: String
phone: String
billingDetails: ContactDetails
shippingDetails: ContactDetails
metadata: [KeyValueItem!]
defaultTokenId: ID
createdAt: AWSDateTime
updatedAt: AWSDateTime
}

Fields​

Customer.id ● ID scalar​

Customer ID. null on the copy embedded in a charge or subscription.

Customer.email ● String scalar​

The customer's email address.

Customer.name ● String scalar​

The customer's full name or business name.

Customer.phone ● String scalar​

The customer's phone number in E.164 format.

Customer.billingDetails ● ContactDetails object​

Billing address. Entity only.

Customer.shippingDetails ● ContactDetails object​

Shipping address. Entity only.

Customer.metadata ● [KeyValueItem!] list object​

Arbitrary key/value metadata. Entity only.

Customer.defaultTokenId ● ID scalar​

Payment method charged when a payment asks for the customer's default. Entity only.

Customer.createdAt ● AWSDateTime scalar​

Creation time. Entity only.

Customer.updatedAt ● AWSDateTime scalar​

Last update time. Entity only.

Returned By​

createCustomer mutation ● customer query ● updateCustomer mutation

Member Of​

Charge object ● ChargeEventObject object ● CustomersConnection object ● Payment object ● Subscription object ● SubscriptionEventObject object