Schema

schema {
  query: GQLQueries
  mutation: GQLMutations
}

Activity Log

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

Addon

type AddOnGQLType {
  accountingCode: String
  activeSubscribersCount: Int!
  billingCycle: BillingCycleInfoGQLType
  billingModel: BillingModelGQLType
  billingType: BillingTypeGQLType
  code: String
  currency: CurrencyGQLType
  data: String
  description: String
  displaySettings: String
  fixedPricing: FixedPricingGQLType
  hasActiveSubscribers: Boolean!
  id: ID
  imageUrl: String
  invoiceName: String
  name: String!
  perUnitPricing: PerUnitPricingGQLType
  pricingModel: PricingModelGQLType
  siteId: String!
  status: ActiveStatusGQLType
  variablePricing: VariablePricingGQLType
}

input AddOnGQLInputType {
  accountingCode: String
  billingCycle: BillingCycleInfoGQLInputType
  billingModel: BillingModelGQLType
  billingType: BillingTypeGQLType
  code: String
  data: String
  description: String
  displaySettings: String
  fixedPricing: FixedPricingGQLInputType
  id: ID
  imageUrl: String
  invoiceName: String
  name: String!
  perUnitPricing: PerUnitPricingGQLInputType
  pricingModel: PricingModelGQLType
  status: ActiveStatusGQLType
  variablePricing: VariablePricingGQLInputType
}

Addon Subscription

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

input AddonSubscriptionGQLInputType {
  id: String
  originalAddOnId: ID
  planSubscriptionId: String!
  quantity: Long!
}

Address

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

input AddressGQLInputType {
  city: String
  countryCode: String
  line1: String
  line2: String
  postalCode: String
  province: String
}

API Secret Mutations

type ApiSecretMutations {
  regenerate: ResultGQLType95f0e7bd0457412a93c71e0777e7162b
}

Available Subscription Event

type AvailableSubscriptionEventGQLType {
  availablePlaceholders: [SubscriptionEventPlaceholderGQLType]
  defaultActions: [SubscriptionEventActionGQLType]
  id: String!
  name: String!
}

Billing Cycle

type BillingCycleGQLType {
  end: DateTime
  id: ID
  index: Int
  invoiceId: String
  nextBillingCycleId: ID
  pausingData: [PausingDataGQLType]
  planSubscription: SubscriptionGQLType
  planSubscriptionId: String
  siteId: String!
  start: DateTime
}

Billing Cycle Info

type BillingCycleInfoGQLType {
  dueInvoiceDueSettings: DueInvoiceDueSettingsGQLType
  duration: Int!
  earlyInvoiceCreationSettings: EarlyInvoiceCreationSettingsGQLType
  termLimit: TermLimitGQLType
  unit: IntervalUnitGQLType
  usageQuery: UsageQueryGQLType
}

input BillingCycleInfoGQLInputType {
  dueInvoiceDueSettings: DueInvoiceDueSettingsGQLInputType
  duration: Int!
  earlyInvoiceCreationSettings: EarlyInvoiceCreationSettingsGQLInputType
  termLimit: TermLimitGQLInputType
  unit: IntervalUnitGQLType
  usageQuery: UsageQueryGQLInputType
}

Billing Info

type BillingInfoGQLType {
  additionalInfo: String
  address: AddressGQLType
  email: String
  firstName: String
  lastName: String
  name: String
  phoneNumber: String
}

input BillingInfoGQLInputType {
  additionalInfo: String
  address: AddressGQLInputType
  email: String
  firstName: String
  lastName: String
  phoneNumber: String
}

Change Log

type ChangeLogGQLType {
  by: ID
  description: String!
  id: String!
  timestamp: DateTime
}

Coupon Code

type CouponCodeGQLType {
  code: String!
  id: ID
  redemptionCount: Int!
  siteId: String!
}

Coupon Code Mutations

type CouponCodesMutations {
  delete: ResultGQLType
}

Coupon

type CouponGQLType {
  couponCodes: [CouponCodeGQLType]
  id: ID
  name: String!
  quantity: Int
  siteId: String!
  status: ActiveStatusGQLType
  type: CouponTypeGQLType
  usageRule: RuleGQLType
  validityRule: RuleGQLType
  value: Decimal!
}

input CouponGQLInputType {
  id: ID
  name: String
  status: ActiveStatusGQLType
  type: CouponTypeGQLType
  usageRule: RuleGQLInput
  validityRule: RuleGQLInput
  value: Decimal
}

Coupons Mutations

type CouponsMutations {
  create(coupon: CouponGQLInputType): CouponWithCodesMutations
}

Coupon Mutations

type CouponMutations {
  codes(ids: [String]!): CouponCodesMutations
  delete: ResultGQLType
  update(coupon: CouponGQLInputType!): ResultGQLType
}

Coupon With Codes Mutations

type CouponWithCodesMutations {
  withCodes(
    code: String!
    quantity: Int!
  ): ResultGQLType7df0e48b5b174a64a448417e4e06ce3a
}

Currency

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

Custom Fields Mutations

type CustomFieldsMutations {
  update(customFields: [KeyValuePairGQLInputType]): ResultGQLType
}

Customer

type CustomerGQLType {
  activePlan: String
  activities: [ActivityLogGQLType]
  address: AddressGQLType
  comment: String
  company: String
  customFields: [KeyValuePairGQLType3ffe612317f64c1eb6804fa071122177]
  customerId: String
  documents: [StorageObjectGQLType]
  emailAddress: String
  emails: [EmailGQLType]
  firstJoined: DateTime
  firstName: String
  fullName: String
  id: ID
  infoFields: [CustomerInfoFieldGQLType]
  invoices: [InvoiceInfoGQLType]
  lastName: String
  lifeTimeRevenue: Decimal!
  lifeTimeRevenueCurrency: String!
  manualPayment: Boolean
  paymentMethods: [PaymentMethodGQLType]
  paymentSchedules: [PaymentScheduleGQLType]
  shippingAddress: AddressGQLType
  siteId: String!
  status: SubscriptionStatusGQLType
  subscription(subscriptionId: String!): SubscriptionGQLType
  subscriptions: [SubscriptionGQLType]
  transactions: [TransactionInfoGQLType]
}

input CustomerGQLInputType {
  customerId: String
  emailAddress: String!
  firstName: String!
  lastName: String!
}

Customer Id Mutations

type CustomerIdMutations {
  update(newCustomerId: String!): ResultGQLType95f0e7bd0457412a93c71e0777e7162b
}

Customer Info Field

type CustomerInfoFieldGQLType {
  editable: Boolean
  label: String!
  name: String!
  required: Boolean
  type: String
  validation: String
  value: String!
}

input CustomerInfoFieldGQLInputType {
  editable: Boolean
  label: String!
  name: String!
  required: Boolean
  type: String
  validation: String
  value: String!
}

Customers Mutations

type CustomersMutations {
  create(
    customer: CustomerGQLInputType!
  ): ResultGQLType7b74aafac7c74d9ab5efa8505211324a
}

Customer Mutations

type CustomerMutations {
  customFields: CustomFieldsMutations
  customerId: CustomerIdMutations
  infoFields: InfoFieldsMutations
  invoices: InvoicesMutations
  paymentMethod(paymentMethodId: String!): PaymentMethodMutations
  paymentMethods: PaymentMethodsMutations
  paymentSchedules: PaymentSchedulesMutations
  subscription(planSubscriptionId: String!): CustomerSubscriptionMutations
  subscriptions: CustomerSubscriptionsMutations
}

Customer Subscription Mutations

type CustomerSubscriptionMutations {
  addFreeAddon(addonId: ID!): ResultGQLType
  cancel(immediateCancellation: Boolean): ResultGQLType
  pause(pauseDurationId: String): ResultGQLType
  pauseWithInterval(pauseInterval: IntervalGQLInputType!): ResultGQLType
  reactivate: ResultGQLType
  removeFreeAddon(addonSubscriptionId: String!): ResultGQLType
  resume: ResultGQLType
  suspend: ResultGQLType
  updateFreeAddon(
    addonSubscriptions: [AddonSubscriptionGQLInputType]!
  ): ResultGQLType
}

Customer Subscriptions Mutations

type CustomerSubscriptionsMutations {
  add(planCode: String!): ResultGQLTypeb46b526572074496a64714a7a042ec21
}

Delay

type DelayGQLType {
  delayType: DelayTypeGQLType
  interval: IntervalGQLType
  specificDate: Int
  specificDay: SpecificDayGQLType
}

input DelayInputGQLType {
  delayType: DelayTypeGQLType
  interval: IntervalGQLInputType
  specificDate: Int
  specificDay: SpecificDayGQLType
}

Draft Invoice

type DraftInvoiceGQLType {
  billedOn: DateTime
  createdOn: DateTime
  customer: CustomerGQLType
  data: String
  details: InvoiceDetailsGQLType
  dueOn: DateTime
  id: ID
  siteId: String!
  subTotal: Decimal
  total: Decimal
}

input DraftInvoiceGQLInputType {
  billedOn: DateTime
  customerId: String
  data: String
  details: InvoiceInfoGQLInputType
  dueOn: DateTime
  siteId: String!
}

input DraftFromInvoiceGQLInputType {
  billedOn: DateTime
  dueOn: DateTime
  invoiceId: String!
}

Draft Invoice Mutations

type DraftInvoiceMutations {
  delete: ResultGQLType
  update(draftInvoice: DraftInvoiceGQLInputType!): ResultGQLType
}

Draft Invoices Mutations

type DraftInvoicesMutations {
  create(
    draftInvoice: DraftInvoiceGQLInputType!
  ): ResultGQLType30dc45c3bacf4a91b1578267ac590fb3
  createFromInvoice(
    draftFromInvoice: DraftFromInvoiceGQLInputType!
  ): ResultGQLType30dc45c3bacf4a91b1578267ac590fb3
}

Due Invoice Due Settings

type DueInvoiceDueSettingsGQLType {
  action: ActionOnDueInvoiceDueGQLType
  duration: Int
  unit: IntervalUnitGQLType
}

input DueInvoiceDueSettingsGQLInputType {
  action: ActionOnDueInvoiceDueGQLType
  duration: Int
  unit: IntervalUnitGQLType
}

Dunning Profile

type DunningProfileGQLType {
  dunningFailAction: DunningFailActionGQLType
  id: ID
  name: String
  siteId: String
  trials: [DunningTrialSettingsGQLType]
}

input DunningProfileGQLInputType {
  dunningFailAction: DunningFailActionGQLType
  id: ID
  name: String!
  siteId: String!
  trials: [DunningTrialSettingsGQLInputType]
}

Dunning Profile Mutations

type DunningProfileMutations {
  update(
    dunningProfile: DunningProfileGQLInputType!
  ): ResultGQLType8fb83f2cfd1a4a13b5ab04c220def06b
}

Dunning Profiles Mutations

type DunningProfilesMutations {
  create(
    dunningProfile: DunningProfileGQLInputType!
  ): ResultGQLType8fb83f2cfd1a4a13b5ab04c220def06b
}

Dunning Trial Settings

type DunningTrialSettingsGQLType {
  index: Int
  template: String
  trialDelayInDays: Decimal
  trialPercentage: Decimal
}

input DunningTrialSettingsGQLInputType {
  index: Int!
  template: String!
  trialDelayInDays: Decimal!
  trialPercentage: Decimal!
}

Early Invoice Creation Settings

type EarlyInvoiceCreationSettingsGQLType {
  duration: Int
  unit: IntervalUnitGQLType
}

input EarlyInvoiceCreationSettingsGQLInputType {
  duration: Int
  unit: IntervalUnitGQLType
}

Email

type EmailGQLType {
  address: String
  attachments: [StorageObjectGQLType]
  displayText: String
  id: String
  sentOn: DateTime
}

input EmailSettingsGQLInputType {
  settings: String!
  useApi: Boolean!
  useSmtp: Boolean!
}

Global Setting

type GlobalSettingGQLType {
  data: String!
  id: String!
}

Setting

type SettingGQLType {
  data: String!
  id: String!
  siteId: String!
}
input SettingGQLInputType {
  data: String!
  id: String!
}

Setting Mutations

type SettingMutations {
  update(setting: SettingGQLInputType!): ResultGQLType
}

Info Field

type InfoFieldGQLType {
  disabled: Boolean
  editable: Boolean
  label: String!
  name: String!
  required: Boolean!
  type: String
  validation: String
}
input InfoFieldGQLInputType {
  disabled: Boolean
  editable: Boolean
  label: String!
  name: String!
  required: Boolean!
  type: String
  validation: String
}

Info Fields Mutations

type InfoFieldsMutations {
  update(infoFields: [CustomerInfoFieldGQLInputType]!): ResultGQLType
}

Integration Mutations

type IntegrationMutations {
  update(integration: SiteIntegrationGQLInputType!): ResultGQLType
}

Interval

type IntervalGQLType {
  duration: Int!
  unit: IntervalUnitGQLType
}

input IntervalGQLInputType {
  duration: Int!
  unit: IntervalUnitGQLType
}

Invoice Details

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

Invoice

type InvoiceGQLType {
  billedOn: DateTime
  createdOn: DateTime
  customer: CustomerGQLType
  data: String
  details: InvoiceDetailsGQLType
  dueOn: DateTime
  id: ID
  number: String
  paidOn: DateTime
  paymentInfo: PaymentInfoGQLType
  relatedEntity: RelatedEntityGQLType
  relatedEntityId: String
  siteId: String!
  status: InvoiceStatusGQLType
  subTotal: Decimal
  total: Decimal
  transactions: [TransactionGQLType]
  url: String
}

input InvoiceGQLInputType {
  billedOn: DateTime
  customerId: String
  details: InvoiceInfoGQLInputType
  dueOn: DateTime
  number: String
  siteId: String!
  status: InvoiceStatusGQLType
}

Invoice Info

type InvoiceInfoGQLType {
  billedOn: DateTime
  createdOn: DateTime
  details: InvoiceDetailsGQLType
  dueOn: DateTime
  id: ID
  number: String
  siteId: String!
  status: InvoiceStatusGQLType
  subTotal: Decimal
  total: Decimal
  url: String
}

input InvoiceInfoGQLInputType {
  billingInfo: BillingInfoGQLInputType
  comments: String
  currency: String!
  discounts: [InvoiceSubtotalGQLInputType]
  extraFees: [InvoiceSubtotalGQLInputType]
  lineItems: [InvoiceLineItemGQLInputType]
  paymentDetails: String
  taxes: [InvoiceSubtotalGQLInputType]
  terms: String
}

Invoice Line Item

type InvoiceLineItemGQLType {
  data: String
  end: DateTime
  item: String!
  order: Int!
  quantity: Decimal!
  start: DateTime!
  total: Decimal
  unitPrice: Decimal!
}

input InvoiceLineItemGQLInputType {
  data: String
  end: DateTime
  item: String
  order: Int
  quantity: Decimal
  start: DateTime
  total: Decimal
  unitPrice: Decimal
}

Invoice Mutations

type InvoiceMutations {
  addDiscount(amount: Decimal!): ResultGQLType
  createFromDraft(
    invoiceFromDraft: InvoiceFromDraftGQLInputType!
  ): ResultGQLTypef94e528dba8e434dab80a86b8b33bdff
  markAsPaid(sitePaymentMethodId: String!): ResultGQLType
  pushInvoice: ResultGQLType
  removeDiscount(amount: Decimal!): ResultGQLType
  requestPayment(paymentMethodId: String): ResultGQLType
  sendPaymentLink: ResultGQLType
  updateDiscounts(amounts: [Decimal]!): ResultGQLType
  void: ResultGQLType
}

input InvoiceFromDraftGQLInputType {
  billedOn: DateTime
  draftInvoiceId: String!
  dueOn: DateTime
}

Invoice Subtotal

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

input InvoiceSubtotalGQLInputType {
  amount: Decimal!
  definition: SummaryItemDefinitionGQLInputType
  description: String
  order: Int
}

Invoices Mutations

type InvoicesMutations {
  create(
    invoice: InvoiceGQLInputType!
  ): ResultGQLTypef94e528dba8e434dab80a86b8b33bdff
}

Key Value Pair

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

input KeyValuePairGQLInputType {
  key: String!
  value: String!
}

Pausing Data

type PausingDataGQLType {
  pausingDuration: Seconds!
  remainingPeriodWhenPaused: Seconds!
  timestamp: DateTime!
}

Pausing Rule

type PausingRuleGQLType {
  operands: PausingRuleGQLType
  operation: RuleOperationGQLType
  value: String
}

input PausingRuleGQLInputType {
  operands: PausingRuleGQLInputType
  operation: String
  value: String
}

Payment Attempt

type PaymentAttemptGQLType {
  succeeded: Boolean
  transactionId: String
  utcTimestamp: DateTime
}

Payment Info

type PaymentInfoGQLType {
  paymentAttempts: [PaymentAttemptGQLType]
}
type PaymentLinkGQLType {
  code: String
  currency: CurrencyGQLType
  data: String
  id: ID
  info: PaymentLinkInfoGQLType
  name: String!
  siteId: String!
  status: ActiveStatusGQLType
  url: String
}

input PaymentLinkGQLInputType {
  code: String!
  currencyCode: String!
  data: String
  info: PaymentLinkInfoGQLInputType
  name: String!
  siteId: String!
  status: ActiveStatusGQLType
}
type PaymentLinkInfoGQLType {
  comments: String
  discounts: [SummaryItemDefinitionGQLType]
  extraFees: [SummaryItemDefinitionGQLType]
  infoFields: [InfoFieldGQLType]
  lineItems: [PaymentLinkLineItemGQLType]
  paymentDetails: String
  taxes: [SummaryItemDefinitionGQLType]
  terms: String
}

input PaymentLinkInfoGQLInputType {
  comments: String
  discounts: [SummaryItemDefinitionGQLInputType]
  extraFees: [SummaryItemDefinitionGQLInputType]
  infoFields: [InfoFieldGQLInputType]
  lineItems: [PaymentLinkLineItemGQLInputType]
  paymentDetails: String
  taxes: [SummaryItemDefinitionGQLInputType]
  terms: String
}
type PaymentLinkLineItemGQLType {
  data: String
  description: String
  fixedPricing: FixedPricingGQLType
  item: String
  perUnitPricing: PerUnitPricingGQLType
  pricingModel: PricingModelGQLType
  variablePricing: VariablePricingGQLType
}

input PaymentLinkLineItemGQLInputType {
  data: String
  description: String
  fixedPricing: FixedPricingGQLInputType
  item: String
  perUnitPricing: PerUnitPricingGQLInputType
  pricingModel: PricingModelGQLType
  variablePricing: VariablePricingGQLInputType
}
type PaymentLinksMutations {
  create(
    paymentLink: PaymentLinkGQLInputType!
  ): ResultGQLType9d1201caf84a49c8b00f7c02b82911a2
}

Payment Method

type PaymentMethodGQLType {
  billingInfo: BillingInfoGQLType
  displayText: String!
  id: String!
  identifier: String
  isDefault: Boolean!
  metaData: String
  providerReference: String
  sitePaymentMethodId: String!
  type: String!
}

input PaymentMethodGQLInputType {
  billingInfo: BillingInfoGQLInputType
  displayText: String!
  id: String
  identifier: String
  isDefault: Boolean!
  metaData: String
  providerReference: String
  sitePaymentMethodId: String!
  type: String!
}

Payment Method Mutations

type PaymentMethodMutations {
  makeDefault: ResultGQLType
  remove: ResultGQLType
}

Payment Method Properties

type PaymentMethodPropertiesGQLType {
  allowsAddPaymentMethod: Boolean
  allowsAddition: Boolean
  allowsMultiplePerCustomer: Boolean
  extraFee: Decimal
  type: PaymentMethodTypeGQLType
}

Payment Method Mutations

type PaymentMethodsMutations {
  add(
    paymentMethod: PaymentMethodGQLInputType!
  ): ResultGQLType4e9fdbddfb7b4897aea0a38e482803bf
}

Payment Schedule

type PaymentScheduleGQLType {
  createdOn: DateTime
  currency: CurrencyGQLType
  customer: CustomerGQLType
  data: String
  dunningProfile: DunningProfileGQLType
  id: ID
  invoice: InvoiceGQLType
  invoiceId: String
  name: String!
  paymentMethod: PaymentMethodGQLType
  product: String!
  scheduledPayments: [ScheduledPaymentGQLType]
  siteId: String!
}

input PaymentScheduleGQLInputType {
  currencyCode: String
  customerId: String
  data: String
  dunningProfileId: ID
  name: String!
  paymentMethod: PaymentMethodGQLInputType
  product: String!
  scheduledPayments: [ScheduledPaymentGQLInputType]
  siteId: String!
}

Payment Schedule Mutations

type PaymentScheduleMutations {
  changeDunningProfile(dunningProfileId: String!): ResultGQLType
  changePaymentMethod(paymentMethod: PaymentMethodGQLInputType!): ResultGQLType
  scheduledPayment(scheduledPaymentId: String!): ScheduledPaymentMutations
  scheduledPaymentList(ids: [String!]!): ScheduledPaymentListMutations
  scheduledPayments: ScheduledPaymentsMutations
}

Payment Schedule Template

type PaymentScheduleTemplateGQLType {
  data: String
  description: String!
  id: ID
  name: String!
  payments: [PaymentScheduleTemplateItemGQLType]
  siteId: String!
}

input PaymentScheduleTemplateGQLInputType {
  data: String
  description: String
  id: ID
  name: String!
  payments: [PaymentScheduleTemplateItemGQLInputType]
  siteId: String!
}

input PaymentScheduleFromTemplateGQLInputType {
  baseAmount: Decimal
  baseDate: DateTime
  currencyCode: String
  customerId: String
  paymentScheduleTemplateId: ID
  product: String
  selectedPaymentMethodId: String
}

Payment Schedule Template Item

type PaymentScheduleTemplateItemGQLType {
  intervalDuration: Int!
  intervalUnit: IntervalUnitGQLType
  name: String!
  order: Int!
  percentageAmount: Decimal!
}

input PaymentScheduleTemplateItemGQLInputType {
  intervalDuration: Int!
  intervalUnit: IntervalUnitGQLType
  name: String!
  order: Int!
  percentageAmount: Decimal!
}

Payment Schedule Template Mutations

type PaymentScheduleTemplateMutations {
  delete: ResultGQLType
  update(
    paymentScheduleTemplate: PaymentScheduleTemplateGQLInputType!
  ): ResultGQLTypefbd81778f51343b695e37982cf0f01b5
}

Payment Schedule Templates Mutations

type PaymentScheduleTemplatesMutations {
  create(
    paymentScheduleTemplate: PaymentScheduleTemplateGQLInputType!
  ): ResultGQLTypefbd81778f51343b695e37982cf0f01b5
}

Payment Schedules Mutations

type PaymentSchedulesMutations {
  create(
    paymentSchedule: PaymentScheduleGQLInputType!
  ): ResultGQLType0cddc205b1ae4b60ad398663f0b4e3de
  createFromTemplate(
    paymentScheduleFromTemplate: PaymentScheduleFromTemplateGQLInputType!
  ): ResultGQLType0cddc205b1ae4b60ad398663f0b4e3de
}

Per Unit Pricing

type PerUnitPricingGQLType {
  displayCurrencyConversion: Decimal
  extraFees: [SummaryItemDefinitionGQLType]
  freeQuantity: Long!
  pricePerUnit: Decimal!
  rules: PricingRulesGQLType
  taxes: [SummaryItemDefinitionGQLType]
  unit: String!
}

input PerUnitPricingGQLInputType {
  displayCurrencyConversion: Decimal
  extraFees: [SummaryItemDefinitionGQLInputType]
  freeQuantity: Long!
  pricePerUnit: Decimal!
  rules: PricingRulesGQLInputType
  taxes: [SummaryItemDefinitionGQLInputType]
  unit: String!
}

Plan

type PlanGQLType {
  accountingCode: String
  activeSubscribersCount: Int
  addOns: [AddOnGQLType]
  billingCycle: BillingCycleInfoGQLType
  billingModel: BillingModelGQLType
  billingType: BillingTypeGQLType
  changeLog: [ChangeLogGQLType]
  checkoutNotes: String
  data: String
  defaultCurrency: CurrencyGQLType
  description: String
  discountedFrom: Decimal
  displayCurrency: CurrencyGQLType
  displaySettings: String
  dunningProfile: DunningProfileGQLType
  effectiveEndDate: DateTime
  effectiveStartDate: DateTime
  fixedPricing: FixedPricingGQLType
  hasActiveSubscribers: Boolean
  hostedPageUrl: String
  id: ID
  imageUrl: String
  infoFields: [InfoFieldGQLType]
  invoiceName: String
  name: String!
  perUnitPricing: PerUnitPricingGQLType
  planCode: String!
  planFutureStarts: [PlanFutureStartGQLType]
  planPausingDurations: [PlanPausingDurationGQLType]
  planRules: PlanRulesGQLType
  pricingModel: PricingModelGQLType
  productName: String
  setupFee: Decimal
  siteId: String!
  status: ActiveStatusGQLType
  trialPeriod: TrialPeriodSettingsGQLType
  variablePricing: VariablePricingGQLType
}

input PlanGQLInputType {
  accountingCode: String
  addOns: [AddOnGQLInputType]
  billingCycle: BillingCycleInfoGQLInputType
  billingModel: BillingModelGQLType
  billingType: BillingTypeGQLType
  checkoutNotes: String
  data: String
  defaultCurrencyCode: String
  description: String
  discountedFrom: Decimal
  displayCurrencyCode: String
  displaySettings: String
  dunningProfileId: ID
  fixedPricing: FixedPricingGQLInputType
  id: ID
  imageUrl: String
  infoFields: [InfoFieldGQLInputType]
  invoiceName: String
  name: String!
  perUnitPricing: PerUnitPricingGQLInputType
  planCode: String!
  planFutureStarts: [PlanFutureStartGQLInputType]
  planPausingDurations: [PlanPausingDurationGQLInputType]
  planRules: PlanRulesGQLInputType
  pricingModel: PricingModelGQLType
  productName: String!
  setupFee: Decimal
  siteId: String!
  status: ActiveStatusGQLType
  trialPeriod: TrialPeriodSettingsGQLInputType
  variablePricing: VariablePricingGQLInputType
}

Plans Mutations

type PlansMutations {
  create(plan: PlanGQLInputType!): ResultGQLType6a1a9127c722405b9fe9b370aa5f065a
}

Plan Mutations

type PlanMutations {
  update(plan: PlanGQLInputType!): ResultGQLType6a1a9127c722405b9fe9b370aa5f065a
}

Plan Future Start

type PlanFutureStartGQLType {
  displayText: String!
  id: ID
  interval: IntervalGQLType
  planId: ID
  rule: RuleGQLType
  siteId: String!
}

input PlanFutureStartGQLInputType {
  displayText: String!
  interval: IntervalGQLInputType
  planId: ID
  rule: RuleGQLInput
  siteId: String!
}

Plan Pausing Duration

type PlanPausingDurationGQLType {
  displayText: String!
  id: ID
  pausingRule: PausingRuleGQLType
  pausingValue: IntervalGQLType
  planId: ID
  siteId: String!
}

input PlanPausingDurationGQLInputType {
  displayText: String!
  pausingRule: PausingRuleGQLInputType
  pausingValue: IntervalGQLInputType
  planId: ID
  siteId: String!
}

Plan Rules

type PlanRulesGQLType {
  exactTotalAddonsQuantity: Long
  maxTotalAddonsQuantity: Long
}

input PlanRulesGQLInputType {
  exactTotalAddonsQuantity: Long
  maxTotalAddonsQuantity: Long
}

Possible Value

type PossibleValueGQLType {
  label: String!
  value: Int!
}

input PossibleValueGQLInputType {
  label: String!
  value: Int!
}

Pricing Rules

type PricingRulesGQLType {
  max: Int
  min: Int
  step: Int
  values: [PossibleValueGQLType]
}

input PricingRulesGQLInputType {
  max: Int
  min: Int
  step: Int
  values: [PossibleValueGQLInputType]
}

Fixed Pricing

type FixedPricingGQLType {
  displayCurrencyConversion: Decimal
  extraFees: [SummaryItemDefinitionGQLType]
  price: Decimal!
  required: Boolean
  taxes: [SummaryItemDefinitionGQLType]
}

input FixedPricingGQLInputType {
  displayCurrencyConversion: Decimal
  extraFees: [SummaryItemDefinitionGQLInputType]
  price: Decimal!
  required: Boolean
  taxes: [SummaryItemDefinitionGQLInputType]
}

Pricing Tier

type PricingTierGQLType {
  from: Long!
  price: Decimal!
  to: Long
}

input PricingTierGQLInputType {
  from: Long!
  price: Decimal!
  to: Long
}

Variable Pricing

type VariablePricingGQLType {
  displayCurrencyConversion: Decimal
  extraFees: [SummaryItemDefinitionGQLType]
  rules: PricingRulesGQLType
  taxes: [SummaryItemDefinitionGQLType]
  tiers: [PricingTierGQLType]
  type: VariablePricingTypeGQLType
  unit: String
}
input VariablePricingGQLInputType {
  displayCurrencyConversion: Decimal
  extraFees: [SummaryItemDefinitionGQLInputType]
  rules: PricingRulesGQLInputType
  taxes: [SummaryItemDefinitionGQLInputType]
  tiers: [PricingTierGQLInputType]
  type: VariablePricingTypeGQLType
  unit: String!
}

Query Usage Result

type QueryUsageResultGQLType {
  content: String
  isFailed: Boolean
  isSuccess: Boolean
  message: String
  status: String
  statusCode: Int
}

Result

type ResultGQLType {
    data: List[{requestedEntity}]
    isSuccess: Boolean!
    message: String
    result: ResultGQLType
}

Pagination Result

type PaginationResultGQLType {
    data: List[{requestedEntity}]
    isSuccess: Boolean!
    message: String
    pagination: PaginationGQLType
}

Rule

type RuleGQLType {
  name: String
  operands: [RuleGQLType]
  operation: RuleOperationGQLType
  value: String
  valueType: ValueTypeGQLType
}

input RuleGQLInput {
  name: String
  operands: [RuleGQLInput]
  operation: String
  value: String
  valueType: ValueTypeGQLType
}

Scheduled Payment Status

type ScheduledPaymentGQLType {
  amount: Decimal
  data: String
  date: DateTime
  id: ID
  invoice: InvoiceGQLType
  invoiceId: String
  name: String!
  reference: String
  siteId: String!
  status: SchedulePaymentStatusGQLType
}

Scheduled Payment List Mutations

type ScheduledPaymentListMutations {
  delete: ResultGQLType
  markAsPaid: ResultGQLType
}

Scheduled Payment Mutations

type ScheduledPaymentMutations {
  update(scheduledPayment: ScheduledPaymentGQLInputType!): ResultGQLType
}

Scheduled Payments Mutations

type ScheduledPaymentsMutations {
  create(scheduledPayment: ScheduledPaymentGQLInputType!): ResultGQLType
  delete: ResultGQLType
  markAsPaid: ResultGQLType
}

Site Info

type SiteInfoGQLType {
  isDemo: Boolean!
  isTest: Boolean!
  name: String
  organization: OrganizationGQLType
  siteId: String!
  url: String
}

Site Integration

type SiteIntegrationGQLType {
  category: String!
  id: String!
  imageUrl: String!
  isEnabled: Boolean!
  name: String!
  settings: String!
  siteId: String!
}

input SiteIntegrationGQLInputType {
  isEnabled: Boolean
  settings: String
}

Site Payment Method

type SitePaymentMethodGQLType {
  displayImage: String
  displayText: String
  id: ID
  paymentProviderCode: String!
  properties: PaymentMethodPropertiesGQLType
  siteId: String!
}

Site Payment Provider

type SitePaymentProviderGQLType {
  imageUrl: String
  isEnabled: Boolean!
  paymentProviderCode: String!
  settings: String!
  siteId: String!
}

input SitePaymentProviderGQLInputType {
  imageUrl: String
  paymentProviderCode: String!
  settings: String!
  siteId: String!
}

Site Payment Provider Mutations

type SitePaymentProviderMutations {
  update(sitePaymentProvider: SitePaymentProviderGQLInputType!): ResultGQLType
}

Storage Object

type StorageObjectGQLType {
  displayText: String
  id: ID
  objectPath: String
}

Subscribe Customer On Plan Result

type SubscribeCustomerOnPlanResultGQLType {
  checkoutUrl: String
  needCustomization: Boolean
  needPaymentMethod: Boolean
}

Subscription Event Action

type SubscriptionEventActionGQLType {
  email: SubscriptionEventActionEmailGQLType
  isEnabled: Boolean!
  name: String!
  sms: SubscriptionEventActionSmsGQLType
  webhook: SubscriptionEventActionWebhookGQLType
}

input SubscriptionEventActionGQLInputType {
  email: SubscriptionEventActionEmailGQLInputType
  isEnabled: Boolean!
  name: String!
  sms: SubscriptionEventActionSmsGQLInputType
  webhook: SubscriptionEventActionWebhookGQLInputType
}

Subscription Event Action Email

type SubscriptionEventActionEmailGQLType {
  bCC: String
  body: String
  cC: String
  disableBodyTemplate: Boolean
  fromDisplayName: String
  subject: String
  to: String
}

input SubscriptionEventActionEmailGQLInputType {
  bCC: String
  body: String
  cC: String
  disableBodyTemplate: Boolean
  fromDisplayName: String
  subject: String
  to: String
}

Subscription Event Action SMS

type SubscriptionEventActionSmsGQLType {
  body: String
  to: String
}

input SubscriptionEventActionSmsGQLInputType {
  body: String!
  to: String!
}

Subscription Event Action Webhook

type SubscriptionEventActionWebhookGQLType {
  customHeaders: [KeyValuePairGQLType3ffe612317f64c1eb6804fa071122177!]
  endpoint: String
  method: String
  payload: String
}

input SubscriptionEventActionWebhookGQLInputType {
  customHeaders: [KeyValuePairGQLInputType]
  endpoint: String
  method: String
  payload: String
}

Subscription Event

type SubscriptionEventGQLType {
  actions: [SubscriptionEventActionGQLType]
  conditions: RuleGQLType
  delay: DelayGQLType
  id: ID
  info: SubscriptionEventInfoGQLType
  name: String!
  siteId: String!
  subscriptionEventId: String!
}

input SubscriptionEventGQLInputType {
  actions: [SubscriptionEventActionGQLInputType]
  conditions: RuleGQLInput
  delay: DelayInputGQLType
  info: SubscriptionEventInfoInputGQLType
  name: String!
  siteId: String!
  subscriptionEventId: String!
}

Subscription Event Info

type SubscriptionEventInfoGQLType {
  index: Int
}

input SubscriptionEventInfoInputGQLType {
  index: Int
}

Subscription Events Mutations

type SubscriptionEventsMutations {
  add(event: SubscriptionEventGQLInputType!): ResultGQLType
}

Subscription Event Mutations

type SubscriptionEventMutations {
  update(event: SubscriptionEventGQLInputType!): ResultGQLType
}

Subscription Event Placeholder

type SubscriptionEventPlaceholderGQLType {
  label: String
  name: String
  valueType: ValueTypeGQLType
}

Subscription

type SubscriptionGQLType {
  addOns: [AddOnSubscriptionGQLType]
  currency: String!
  currentBillingCycleEnd: DateTime
  currentBillingCycleIndex: Int
  currentBillingCycleStart: DateTime
  endedOn: DateTime
  id: String!
  invoiceOutlines: [InvoiceOutlineGQLType]
    @deprecated(reason: "InvoiceOutlines will be removed next release.")
  pausingInfo: PausingDataGQLType
  plan: PlanGQLType
  quantity: Long
  siteId: String!
  startedOn: DateTime
  status: SubscriptionStatusGQLType
}

Summary Item Definition

type SummaryItemDefinitionGQLType {
  name: String
  rule: RuleGQLType
  type: DefinitionTypeGQLType
  value: Decimal
}

input SummaryItemDefinitionGQLInputType {
  name: String
  rule: RuleGQLInput
  type: DefinitionTypeGQLType
  value: Decimal!
}

Tax Invoice Data

type TaxInvoiceDataGQLType {
  base64: String
  isSuccess: Boolean
  message: String
  name: String
}

Term Limit

type TermLimitGQLType {
  actionOnEnd: ActionOnTermEndGQLType
  cycles: Int
}

input TermLimitGQLInputType {
  actionOnEnd: ActionOnTermEndGQLType
  cycles: Int
}

Transaction

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

Transaction Info

type TransactionInfoGQLType {
  amount: Decimal
  currency: String
  id: ID
  paymentMethod: PaymentMethodGQLType
  status: String
  timestamp: DateTime
}

Trial Period Settings

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

input TrialPeriodSettingsGQLInputType {
  duration: Int!
  requiresCreditCard: Boolean
  unit: IntervalUnitGQLType
}

Usage Query

type UsageQueryGQLType {
  codes: [String]
  customHeaders: [KeyValuePairGQLType3ffe612317f64c1eb6804fa071122177!]
  endpoint: String
  method: String
}

input UsageQueryGQLInputType {
  codes: [String]
  customHeaders: [KeyValuePairGQLInputType]
  endpoint: String
  method: String
}

User

type UserGQLType {
  email: String
  id: String
  name: String
  organizationId: String
}

Webhook Secret Mutations

type WebhookSecretMutations {
  regenerate: ResultGQLType95f0e7bd0457412a93c71e0777e7162b
}

Querying Types

Action On Due Invoice Due

enum ActionOnDueInvoiceDueGQLType {
  "Cancel"
  Cancel
  "DoNothing"
  DoNothing
  "Suspend"
  Suspend
}

Action On Term End

enum ActionOnTermEndGQLType {
  "Ask"
  Ask
  "Cancel"
  Cancel
  "Renew"
  Renew
}

Active Status

enum ActiveStatusGQLType {
  "Active"
  Active
  "Inactive"
  Inactive
}

Billing Mode

enum BillingModelGQLType {
  "PostPaid"
  PostPaid
  "PrePaid"
  PrePaid
}

Billing Type

enum BillingTypeGQLType {
  "OneTime"
  OneTime
  "Recurring"
  Recurring
}

Coupon Type

enum CouponTypeGQLType {
  "FixedAmount"
  FixedAmount
  "Percentage"
  Percentage
}

Definition Type

enum DefinitionTypeGQLType {
  "FixedAmount"
  FixedAmount
  "Percentage"
  Percentage
}

Delay Type

enum DelayTypeGQLType {
  "After"
  After
  "None"
  None
  "SpecificDate"
  SpecificDate
  "SpecificDay"
  SpecificDay
}

Dunning Fail Action

enum DunningFailActionGQLType {
  "Cancel"
  Cancel
  "DoNothing"
  DoNothing
}

Interval Unit

enum IntervalUnitGQLType {
  "Day"
  Day
  "Hour"
  Hour
  "Minute"
  Minute
  "Month"
  Month
  "Quarter"
  Quarter
  "Week"
  Week
  "Year"
  Year
}

Invoice Status

enum InvoiceStatusGQLType {
  "Open"
  Open
  "OverDue"
  OverDue
  "Paid"
  Paid
  "PartiallyPaid"
  PartiallyPaid
  "PartiallyRefunded"
  PartiallyRefunded
  "Processing"
  Processing
  "Refunded"
  Refunded
  "Unknown"
  Unknown
  "Void"
  Void
  "Voiding"
  Voiding
}

Operator

enum OperatorGQLType {
  "And"
  And
  "Contains"
  Contains
  "EndsWith"
  EndsWith
  "Equal"
  Equal
  "GreaterThan"
  GreaterThan
  "GreaterThanOrEqual"
  GreaterThanOrEqual
  "In"
  In
  "LessThan"
  LessThan
  "LessThanOrEqual"
  LessThanOrEqual
  "NotNull"
  NotNull
  "Or"
  Or
  "StartsWith"
  StartsWith
}

Payment Method Type

enum PaymentMethodTypeGQLType {
  "Card"
  Card
  "Cash"
  Cash
  "Cheque"
  Cheque
  "DirectDebit"
  DirectDebit
  "POS"
  POS
  "PayPal"
  PayPal
  "Sepa"
  Sepa
  "Souhoola"
  Souhoola
  "Sympl"
  Sympl
  "Transfer"
  Transfer
  "Valu"
  Valu
  "Wallet"
  Wallet
}

Pricing Model

enum PricingModelGQLType {
  "Fixed"
  Fixed
  "Free"
  Free
  "PerUnit"
  PerUnit
  "Variable"
  Variable
}
enum RelatedEntityGQLType {
  "AddonsSubscriptions"
  AddonsSubscriptions
  "BillingCycle"
  BillingCycle
  "CheckoutSession"
  CheckoutSession
  "DraftInvoice"
  DraftInvoice
  "Invoice"
  Invoice
  "PaymentLink"
  PaymentLink
  "PaymentSchedule"
  PaymentSchedule
  "PlanSubscription"
  PlanSubscription
  "ScheduledPayment"
  ScheduledPayment
}

Rule Operation

enum RuleOperationGQLType {
  "AlwaysFalse"
  AlwaysFalse
  "AlwaysTrue"
  AlwaysTrue
  "And"
  And
  "ContainsAll"
  ContainsAll
  "ContainsAny"
  ContainsAny
  "DoesNotContainAll"
  DoesNotContainAll
  "DoesNotContainAny"
  DoesNotContainAny
  "Equal"
  Equal
  "GreaterThan"
  GreaterThan
  "GreaterThanOrEqual"
  GreaterThanOrEqual
  "In"
  In
  "Key"
  Key
  "LessThan"
  LessThan
  "LessThanOrEqual"
  LessThanOrEqual
  "NotEqual"
  NotEqual
  "NotIn"
  NotIn
  "Or"
  Or
  "Value"
  Value
}

Schedule Payment Status

enum SchedulePaymentStatusGQLType {
  "Cancelled"
  Cancelled
  "Failed"
  Failed
  "NotPaid"
  NotPaid
  "Overdue"
  Overdue
  "Paid"
  Paid
  "Processing"
  Processing
  "Rejected"
  Rejected
}

input ScheduledPaymentGQLInputType {
  amount: Decimal
  data: String
  date: DateTime
  id: String
  name: String!
  paymentScheduleId: String
  reference: String
  siteId: String!
  status: SchedulePaymentStatusGQLType
}

Sorting Direction

enum SortingDirectionGQLType {
  "Ascending"
  Ascending
  "Descending"
  Descending
}

Specific Day

enum SpecificDayGQLType {
  "Friday"
  Friday
  "Monday"
  Monday
  "Saturday"
  Saturday
  "Sunday"
  Sunday
  "Thursday"
  Thursday
  "Tuesday"
  Tuesday
  "Wednesday"
  Wednesday
}

Subscription Status

enum SubscriptionStatusGQLType {
  "Activating"
  Activating
  "Active"
  Active
  "Cancelled"
  Cancelled
  "Cancelling"
  Cancelling
  "FutureStartDate"
  FutureStartDate
  "InTrial"
  InTrial
  "Moved"
  Moved
  "NoSubscription"
  NoSubscription
  "NonRenewing"
  NonRenewing
  "Paused"
  Paused
  "Pausing"
  Pausing
  "Suspended"
  Suspended
}

Value Type

enum ValueTypeGQLType {
  "DateTime"
  DateTime
  "List"
  List
  "None"
  None
  "Number"
  Number
  "Object"
  Object
  "Text"
  Text
}

Variable Pricing Type

enum VariablePricingTypeGQLType {
  "StairStep"
  StairStep
  "Tiered"
  Tiered
  "Volume"
  Volume
}

"The DateTime scalar type represents a date and time. DateTime expects timestamps to be formatted in accordance with the ISO-8601 standard." scalar DateTime

scalar Decimal

scalar Guid

scalar Long

"The Seconds scalar type represents a period of time represented as the total number of seconds in range -922337203685, 922337203685." scalar Seconds

GQL Queries

type GQLQueries {
  addons(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLType3550853005ea4452b2ab661327ad6941
  availableActions(siteId: String!): [String]
  availableSubscriptionEvents(
    siteId: String!
  ): [AvailableSubscriptionEventGQLType]
  base64ImageFromUrl(
    url: String!
  ): ResultGQLType95f0e7bd0457412a93c71e0777e7162b
  billingCycles(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLType76abc31896ae46c495c83dfd5f78dbeb
  coupon(couponId: String!, siteId: String!): CouponGQLType
  coupons(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLType05099a9fe3cf40e8a420bd7bc7ec00fe
  currencySettings(siteId: String!): SettingGQLType
  customer(customerId: String!, siteId: String!): CustomerGQLType
  customerByEmail(email: String!, siteId: String!): CustomerGQLType
  customerOperationJwt(
    customerId: String!
    operation: String!
    siteId: String!
    subscriptionId: String
  ): ResultGQLType95f0e7bd0457412a93c71e0777e7162b
  customers(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLType3557ed4f7c3c40cea2171a2d44074dcb
  downloadTaxInvoice(
    invoiceId: String!
    siteId: String!
  ): ResultGQLTypeee07b15df48d4c16b31603d56d9559bc
  draftInvoice(draftInvoiceId: String!, siteId: String!): DraftInvoiceGQLType
  draftInvoices(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTypea5f5b453ad2c4ce6a1e8978ee6a5122e
  dunningProfile(
    dunningProfileId: String!
    siteId: String!
  ): DunningProfileGQLType
  dunningProfiles(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTyped76a64806a3d488ca37470f7f6fc31a3
  getApiSecret(siteId: String!): ResultGQLType95f0e7bd0457412a93c71e0777e7162b
  getSiteManualPaymentMethods(siteId: String!): [SitePaymentMethodGQLType]
  getSitePaymentMethods(siteId: String!): [SitePaymentMethodGQLType]
  globalSettings(ids: [String]): [GlobalSettingGQLType]
  integrations(category: String, siteId: String!): [SiteIntegrationGQLType]
  invoice(invoiceId: String!, siteId: String!): InvoiceGQLType
  invoices(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTypea2e0042b09ee40a282cd41889573b199
  invoicesById(
    ids: [String]!
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTypea2e0042b09ee40a282cd41889573b199
  paymentLink(paymentLinkId: String!, siteId: String!): PaymentLinkGQLType
  paymentLinks(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTypeef6fec782a9e444d98db42bc834c04dd
  paymentSchedule(
    paymentScheduleId: String!
    siteId: String!
  ): PaymentScheduleGQLType
  paymentScheduleTemplate(
    paymentScheduleTemplateId: String!
    siteId: String!
  ): PaymentScheduleTemplateGQLType
  paymentScheduleTemplates(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLType623032825a58419ea0c95aaaba72ef22
  paymentSchedules(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTypec3f156bdd76d4239809f33fa961d3700
  paymentSchedulesById(
    ids: [String]!
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTypec3f156bdd76d4239809f33fa961d3700
  plan(planCode: String!, siteId: String!): PlanGQLType
  plans(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTypeb0f73963d9ad4f8abcee68704c0b6713
  portalSettings(url: String!): SettingGQLType
  queryUsage(
    siteId: String!
    subscriptionId: String!
    utcEndDate: DateTime!
    utcStartDate: DateTime!
  ): ResultGQLType84078a7d9a644705a739290a3571be2c
  settings(settings: [String], siteId: String!): [SettingGQLType]
  siteInfo(siteId: String!): ResultGQLType71c82b6f505f42d1ad0049472baabf6a
  siteIntegration(
    integrationId: String!
    siteId: String!
  ): SiteIntegrationGQLType
  sitePaymentProviders(siteId: String!): [SitePaymentProviderGQLType]
  subscriptionEvents(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTypec98a82d9791c4cb3a24af4a2c9f4219b
  transaction(siteId: String!, transactionId: String!): TransactionGQLType
  transactions(
    filter: FilterGQLInputType
    pagination: PaginationGQLInputType
    siteId: String!
    sorting: [SortingGQLInputType]
  ): PaginationResultGQLTypeae247f72d1e34e43bcaa79754043c433
  verifyEmailSettings(
    emailSettings: EmailSettingsGQLInputType!
    siteId: String!
    testEmail: String!
  ): ResultGQLType
  verifySmsSettings(
    apiSettings: String!
    clientName: String!
    siteId: String!
    testSms: String!
  ): ResultGQLType
  verifyUsageApi(
    siteId: String!
    usageQuery: UsageQueryGQLInputType!
  ): ResultGQLType84078a7d9a644705a739290a3571be2c
  verifyWebhookSettings(
    siteId: String!
    subscriptionEventId: String!
    webhookSettings: SubscriptionEventActionWebhookGQLInputType!
  ): ResultGQLType
}

Filter

input FilterGQLInputType {
  field: String
  operands: [FilterGQLInputType]
  operator: OperatorGQLType
  value: String
}

Sorting

input SortingGQLInputType {
  direction: SortingDirectionGQLType
  field: String
}

Pagination

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

input PaginationGQLInputType {
  page: Int
  perPage: Int
}

GQL Mutations

type GQLMutations {
  apiSecret(siteId: String!): ApiSecretMutations
  coupon(couponId: String, siteId: String!): CouponMutations
  coupons(siteId: String!): CouponsMutations
  customer(customerId: String, siteId: String!): CustomerMutations
  customers(siteId: String!): CustomersMutations
  draftInvoice(draftInvoiceId: String!, siteId: String!): DraftInvoiceMutations
  draftInvoices(siteId: String!): DraftInvoicesMutations
  dunningProfile(
    dunningProfileId: String!
    siteId: String!
  ): DunningProfileMutations
  dunningProfiles(siteId: String!): DunningProfilesMutations
  integration(integrationId: String!, siteId: String!): IntegrationMutations
  invoice(invoiceId: String, siteId: String!): InvoiceMutations
  organization(orgId: String!): OrganizationMutations
  paymentLinks(siteId: String!): PaymentLinksMutations
  paymentSchedule(
    paymentScheduleId: String!
    siteId: String!
  ): PaymentScheduleMutations
  paymentScheduleTemplate(
    paymentScheduleTemplateId: String!
    siteId: String!
  ): PaymentScheduleTemplateMutations
  paymentScheduleTemplates(siteId: String!): PaymentScheduleTemplatesMutations
  plan(planId: String!, siteId: String!): PlanMutations
  plans(siteId: String!): PlansMutations
  setting(siteId: String!): SettingMutations
  sitePaymentProvider(
    paymentProviderCode: String!
    siteId: String!
  ): SitePaymentProviderMutations
  subscriptionEvent(
    siteId: String!
    siteSubscriptionEventId: Guid!
  ): SubscriptionEventMutations
  subscriptionEvents(siteId: String!): SubscriptionEventsMutations
  webhookSecret(siteId: String!): WebhookSecretMutations
}
Table of Contents