Skip to main content

Customer

A customer of a channel.

type Customer {
campaignOrdersCount: Int
id: GlobalID!
channel: Channel!
email: Email
externalId: ID!
firstName: String
lastName: String
phone: PhoneNumber
status: CustomerStatus!
taxable: Boolean!
verifiedEmail: Boolean!
activeSubscriptionsCount: Count!
subscriptionsCount: Count!
}

Fields​

Customer.campaignOrdersCount ● Int scalar types​

The number of campaign orders the customer has placed, including cancelled orders.

Customer.id ● GlobalID! non-null scalar types​

The customer's ID.

Customer.channel ● Channel! non-null object types​

The channel the customer belongs to.

Customer.email ● Email scalar types​

The customer's email address.

Customer.externalId ● ID! non-null scalar types​

The customer's ID in the channel's external platform, such as the Shopify customer ID.

Customer.firstName ● String scalar types​

The customer's first name.

Customer.lastName ● String scalar types​

The customer's last name.

Customer.phone ● PhoneNumber scalar types​

The customer's phone number.

Customer.status ● CustomerStatus! non-null enum types​

The customer's status.

Customer.taxable ● Boolean! non-null scalar types​

Whether the customer pays tax.

Customer.verifiedEmail ● Boolean! non-null scalar types​

Whether Submarine has checked that the customer's email address is valid.

Customer.activeSubscriptionsCount ● Count! non-null scalar types​

The number of the customer's subscriptions that are active.

Customer.subscriptionsCount ● Count! non-null scalar types​

The total number of the customer's subscriptions, in any status.

Returned By​

customer query

Member Of​

CampaignOrder object ● CampaignOrderGroup object ● Charge object ● PaymentIntent object ● PaymentMethod object ● Refund object ● Subscription object ● SubscriptionEvent object ● SubscriptionOrder object