RollerupCustomer

RollerupCustomer

Represents a RollerUp customer with their subscriptions

Kind: Object

Fields

Field Type Description
city String City
country String Country
createdAt DateTime! Timestamp when the customer was created
email EmailAddress Customer’s email address
externalBillingId String for externally managed customers only, the id in the external system
id ID! Unique identifier
isActiveMember Boolean! Whether the customer is an active member. True if the customer has at least one car assigned to a membership (i.e. a membership_car exists). This is independent of subscription billing status.
isExternallyManaged Boolean! Whether the customer is managed by an external billing system (e.g. drb). Externally-managed customers cannot be edited via the API.
name String Customer’s full name
notes [Note!]! List of active (non-archived) notes for this customer
Requires customers:view
phone PhoneNumber Customer’s phone number in E.164 format
state String State
street1 String Street address line 1
street2 String Street address line 2
subscriptions [RollerupSubscription!]! List of subscriptions for this customer
updatedAt DateTime! Timestamp when the customer was last updated
zip String ZIP/postal code

Definition

"""Represents a RollerUp customer with their subscriptions"""
type RollerupCustomer {
  """City"""
  city: String
  """Country"""
  country: String
  """Timestamp when the customer was created"""
  createdAt: DateTime!
  """Customer's email address"""
  email: EmailAddress
  """for externally managed customers only, the id in the external system"""
  externalBillingId: String
  """Unique identifier"""
  id: ID!
  """
  Whether the customer is an active member. True if the customer has at least one car assigned to a membership (i.e. a membership_car exists). This is independent of subscription billing status.
  """
  isActiveMember: Boolean!
  """
  Whether the customer is managed by an external billing system (e.g. drb). Externally-managed customers cannot be edited via the API.
  """
  isExternallyManaged: Boolean!
  """Customer's full name"""
  name: String
  """List of active (non-archived) notes for this customer"""
  notes: [Note!]! @authz(permission: "customers:view")
  """Customer's phone number in E.164 format"""
  phone: PhoneNumber
  """State"""
  state: String
  """Street address line 1"""
  street1: String
  """Street address line 2"""
  street2: String
  """List of subscriptions for this customer"""
  subscriptions: [RollerupSubscription!]!
  """Timestamp when the customer was last updated"""
  updatedAt: DateTime!
  """ZIP/postal code"""
  zip: String
}