GraphQL Schema V1

type CustomerGQLType {
  activePlan: String
  activities: [ActivityLogGQLType]
  address: AddressGQLType
  comment: String
  company: String
  customerId: String
  customFields: [KeyValuePairGQLType]
  emailAddress: String!
  firstJoined: DateTime
  firstName: String!
  fullName: String!
  id: ID
  infoFields: [CustomerInfoFieldGQLType]
  invoices: [InvoiceGQLType]
  lastName: String!
  lifeTimeRevenue: Decimal!
  lifeTimeRevenueCurrency: String!
  nextInvoiceOn: DateTime
  paymentMethods: [PaymentMethodGQLType]
  shippingAddress: AddressGQLType
  siteId: String!
  status: String!
  subscriptions: [SubscriptionGQLType]
  transactions: [TransactionGQLType]
}

type ActivityLogGQLType {
  displayText: String
  doneBy: ID
  id: String!
  timestamp: DateTime
}

type AddressGQLType {
  city: String!
  countryCode: String!
  line1: String!
  line2: String!
  postalCode: String!
  province: String!
}

type KeyValuePairGQLType {
  key: String!
  value: String!
}

type CustomerInfoFieldGQLType {
  label: String!
  name: String!
  value: String!
}

type InvoiceGQLType {
  billedOn: DateTime
  createdOn: DateTime
  dueOn: DateTime
  id: ID
  info: InvoiceInfoGQLType
  number: String
  siteId: String!
  status: String
}

type InvoiceInfoGQLType {
  billingInfo: BillingInfoGQLType
  currency: String!
  discounts: [InvoiceSubtotalGQLType]
  extraFees: [InvoiceSubtotalGQLType]
  lineItems: [InvoiceLineItemGQLType]
  paymentDetails: String
  taxes: [InvoiceSubtotalGQLType]
  terms: String
}

type InvoiceLineItemGQLType {
  end: Date
  item: String!
  order: Int!
  quantity: Decimal!
  start: Date!
  unitPrice: Decimal!
}

type InvoiceSubtotalGQLType {
  amount: Decimal!
  description: String!
  order: Int!
}

type PaymentMethodGQLType {
  billingInfo: BillingInfoGQLType
  displayText: String!
  isDefault: Boolean!
  type: String!
}

type PlanGQLType {
  accountingCode: String
  addOns: [AddOnGQLType]
  billingCycle: BillingCycleGQLType
  billingType: BillingType
  billingModel: BillingModel
  defaultCurrency: CurrencyGQLType
  description: String
  discountedFrom: Decimal
  displaySettings: String
  effectiveEndDate: DateTime
  effectiveStartDate: DateTime
  fixedPricing: FixedPricingGQLType
  hasActiveSubscribers: Boolean!
  hostedPageUrl: String!
  id: ID
  imageUrl: String
  invoiceName: String
  name: String!
  perUnitPricing: PerUnitPricingGQLType
  planCode: String!
  pricingModel: PricingModel
  productName: String
  setupFee: Decimal
  siteId: String!
  status: ActiveStatus
  trialPeriod: TrialPeriodSettingsGQLType
  variablePricing: VariablePricingGQLType
}

type AddOn {
  accountingCode: String
  billingCycle: BillingCycleGQLType
  billingType: BillingType
  billingModel: BillingModel
  currency: CurrencyGQLType
  description: String
  displaySettings: String
  fixedPricing: FixedPricingGQLType
  hasActiveSubscribers: Boolean!
  id: ID
  imageUrl: String
  invoiceName: String
  name: String!
  perUnitPricing: PerUnitPricingGQLType
  pricingModel: PricingModel
  siteId: String!
  status: ActiveStatus
  variablePricing: VariablePricingGQLType
}

enum ActiveStatus {
  Active
  Inactive
}

type BillingCycleGQLType {
  duration: Int!
  termLimit: TermLimitGQLType
  unit: IntervalUnit
}

enum BillingType {
  OneTime
  Recurring
}

type CurrencyGQLType {
  code: String!
  displayText: String!
  symbol: String!
}

enum PricingModel {
  Fixed
  PerUnit
  Variable
}

type FixedPricingGQLType {
  price: Decimal!
  required: Boolean
}

type PerUnitPricingGQLType {
  freeQuantity: Int!
  pricePerUnit: Decimal!
  unit: String!
  unitsPerIncrement: Int!
}

type VariablePricingGQLType {
  tiers: [PricingTierGQLType]
  type: VariablePricingType
  unit: String
}

type PricingTierGQLType {
  from: Int!
  price: Decimal!
  to: Int
  unitsPerIncrement: Int!
}

enum VariablePricingType {
  Tiered
  Volume
  StairStep
}

type TrialPeriodSettingsGQLType {
  duration: Int!
  requiresCreditCard: Boolean!
  unit: IntervalUnit
}

enum IntervalUnit {
  Day
  Week
  Month
  Quarter
  Year
}

type TermLimitGQLType {
  actionOnEnd: ActionOnTermEnd
  cycles: Int
}

enum ActionOnTermEnd {
  Renew
  Cancel
}

type SubscriptionGQLType {
  addOns: [AddOnSubscriptionGQLType]
  currency: String
  endedOn: DateTime
  id: String!
  plan: PlanGQLType
  quantity: Int
  siteId: String!
  startedOn: DateTime
  status: SubscriptionStatus
}

type AddOnSubscriptionGQLType {
  addOn: AddOnGQLType
  endedOn: DateTime
  id: String!
  movedTo: String
  quantity: Int
  startedOn: DateTime
  status: SubscriptionStatus
}

enum SubscriptionStatus {
  InTrial
  Active
  FutureStartDate
  Paused
  NonRenewing
  Cancelled
  Moved
  Activating
  Pausing
  Cancelling
}

type TransactionGQLType {
  amount: Decimal
  currency: String
  customer: CustomerGQLType
  gatewayResponse: String
  id: ID
  paymentMethod: PaymentMethodGQLType
  referenceNumber: String
  siteId: String!
  status: String
  timestamp: DateTime
  type: String
}

type PaymentInfoGQLType{
  paymentAttempts: [PaymentAttemptsGQLType]
}

type PaymentAttemptsGQLType {
    succeeded: Boolean!
    transactionId: String!
    utcTimestamp: DateTime!
    sitePaymentMethodId: String!

type PaginationGQLType {
  page: Int
  perPage: Int
  totalRecords: Int
}

type PaginationGQLInputType {
  page: Int
  perPage: Int
}

type SortingGQLInputType {
  field: String
  direction: String
}

enum Direction {
  Ascending
  Descending
}

type FilterGQLInputType {
  field: String
  operator: String
  value: String
}

enum Operator {
  Equal,
  GreaterThan,
  GreaterThanOrEqual,
  LessThan,
  LessThanOrEqual,
  Contains,
  StartsWith,
  EndsWith
}