Objects

Account

Fields

Name	Description
billing Billing
capabilities AccountCapabilities!
createdAt Date
id ID!
isProduction Boolean
metadata JSON
name String!
settings AccountSettings!
updatedAt Date

AccountAnalyticsSettings

Fields

Name	Description
dashboardId String
isAvailableInGlobalDashboard Boolean

AccountBillingSettings

Fields

Name	Description
customTaxRate CustomTaxRate
footerText String
logoUrl String
numberingFormat AccountBillingSettingsNumberingFormat
taxSchemes [String!]

AccountBillingSettingsNumberingFormat

Fields

Name	Description
creditNote String
invoice String

AccountCapabilities

Fields

Name	Description
canBill Boolean
canCreateApps Boolean
canCreateCustomDomains Boolean
canCustomizeFields Boolean
canInviteMembers Boolean
canManageLicenses Boolean
hasAnalytics Boolean
hasCancellationNotice Boolean
hasCheckout Boolean
hasCustomerPortal Boolean
hasIntegrations Boolean

AccountDomainConfigSettings

Fields

Name	Description
hostname String!
isVerified Boolean!
verificationRecord AccountDomainConfigVerificationSettings!

AccountDomainConfigVerificationSettings

Fields

Name	Description
name String!
type String!
value String!

AccountDomainSettings

Fields

Name	Description
config AccountDomainConfigSettings
name String!

AccountList

Fields

Name	Description
count Int!
cursor String
items [Account]!
total Int!

AccountMetadataField

Fields

Name	Description
default String
description String!
displayInCheckoutStep String
format String
isPersonalInformation Boolean
label String
name String!
options [AccountMetadataOptionField!]
required Boolean!
type String!

AccountMetadataOptionField

Fields

Name	Description
label String!
value String!

AccountMetadataSettings

Fields

Name	Description
billingProfile [AccountMetadataField!]
creditNote [AccountMetadataField!]
customer [AccountMetadataField!]
invoice [AccountMetadataField!]
license [AccountMetadataField!]
licenseUser [AccountMetadataField!]
person [AccountMetadataField!]
product [AccountMetadataField!]
subscription [AccountMetadataField!]
transaction [AccountMetadataField!]

AccountPaymentMethodSettings

Fields

Name	Description
isActive Boolean!
providerName PaymentProviderName!
type PaymentMethodType!

AccountPaymentSettings

Fields

Name	Description
paymentMethods [AccountPaymentMethodSettings!]
providers [PaymentProvider!]

AccountSettings

Fields

Name	Description
analytics AccountAnalyticsSettings
billing AccountBillingSettings!
capabilities [ProductCapabilitySettings!]
domain AccountDomainSettings!
metadata AccountMetadataSettings
payments AccountPaymentSettings
theme AccountThemeSettings

AccountTheme

Fields

Name	Description
logoUrl String

AccountThemeSettings

Fields

Name	Description
dark AccountTheme
light AccountTheme

AnalyticsSessionToken

Fields

Name	Description
dashboardId String!
token String!

ApiClient

Fields

Name	Description
id ID!
redirectUrls [String!]
scopes [Scope!]
secret String
type String!

App

Fields

Name	Description
accountIds [String!]
apiClients [ApiClient!]!
categories [String!]
createdAt Date
description String
id ID!
instances AppInstanceList
isInstalled Boolean!
isPublic Boolean!
logoUrl String
name String!
pageContent String
privacyUrl String
tosUrl String
updatedAt Date
webhooks Webhook!

AppInstance

Fields

Name	Description
account Account!
app PublicApp!
createdAt Date!
id ID!

AppInstanceList

Fields

Name	Description
count Int!
cursor String
items [AppInstance!]!
total Int!

AppList

Fields

Name	Description
count Int!
cursor String
items [App!]!
total Int!

Billing

Fields

Name	Description
address String!
address2 String
city String!
companyName String
countryCode String!
metadata JSON
postalCode String!
street String
streetNumber String
taxIds [TaxId!]

CreditNote

Fields

Name	Description
createdAt Date
customer Customer!
id ID!
invoice InvoiceListItem!
items [CreditNoteItem!]!
metadata JSON
number String!
pdfFile String!
subtotal Float!
taxes [CreditNoteTaxItem!]
total Float!
transactions TransactionList!
updatedAt Date

CreditNoteDiscount

Fields

Name	Description
amount Float!
description String!

CreditNoteExport

Fields

Name	Description
content String!

CreditNoteItem

Fields

Name	Description
description String!
price Float!
quantity Float!
unitPrice Float!

CreditNoteList

Fields

Name	Description
count Int!
cursor String
items [CreditNoteListItem!]!
total Int!

CreditNoteListItem

Fields

Name	Description
createdAt Date
customer Customer!
id ID!
invoice InvoiceListItem!
items [CreditNoteItem!]!
metadata JSON
number String!
subtotal Float!
taxes [CreditNoteTaxItem!]
total Float!
transactions TransactionList!
updatedAt Date

CreditNotePreview

Fields

Name	Description
content String!

CreditNoteTaxItem

Fields

Name	Description
amount Float!
description String!
rate Float!

Customer

Fields

Name	Description
billing Billing
capabilities [ProductCapability!]
createdAt Date
creditNotes CreditNoteList!	Arguments Name Description filters FilterInput
currency Currency
discountCoupons DiscountCouponList!	Arguments Name Description filters FilterInput
id ID!
invoices InvoiceList!	Arguments Name Description filters FilterInput
licenseUsers LicenseUserList!	Arguments Name Description filters FilterInput
locale String
metadata JSON
name String!
paymentMethod PaymentMethod
people [Person!]
subscriptions SubscriptionList!	Arguments Name Description filters FilterInput
transactions TransactionList!	Arguments Name Description filters FilterInput
updatedAt Date

CustomerList

Fields

Name	Description
count Int!
cursor String
items [Customer!]!
total Int!

CustomerSession

Fields

Name	Description
customer Customer
estimation PriceEstimation
fields [AccountMetadataField!]
id ID!
payment PaymentSession
product Product
subscription Subscription

CustomerSessionProduct

Fields

Name	Description
canDowngradeTo CustomerSessionProductList!
canUpgradeTo CustomerSessionProductList!
currency Currency!
id ID!
name String!
nextProduct CustomerSessionProduct
plan Plan!
pricing [Pricing!]!
sku String!

CustomerSessionProductList

Fields

Name	Description
count Int!
cursor String
items [CustomerSessionProduct!]!
total Int!

CustomTaxRate

Fields

Name	Description
code String!
description String!
rate Float!

Discount

Fields

Name	Description
amount Float!
code String
createdAt Date
currency Currency
expirationDate Date
id ID!
isActive Boolean
maxDuration Timeframe
maxPeriods Int
maxRedemptions Int
metadata JSON
name String!
type DiscountType!
updatedAt Date

DiscountCoupon

Fields

Name	Description
code String!
createdAt Date
customer Customer!
discount Discount!
id ID!
metadata JSON
updatedAt Date

DiscountCouponList

Fields

Name	Description
count Int!
cursor String
items [DiscountCoupon!]!
total Int!

DiscountList

Fields

Name	Description
count Int!
cursor String
items [Discount!]!
total Int!

Invoice

Fields

Name	Description
billingPeriodEnd Date!
billingPeriodStart Date!
buyer Billing!
createdAt Date
creditNotes CreditNoteList!
currency Currency!
customer Customer!
discount InvoiceDiscount
dueDate Date!
id ID!
items [InvoiceItem!]!
locale String
metadata JSON
number String!
paymentDate Date
paymentTermDays Int
pdfFile String!
seller Billing!
subtotal Float!
taxes [InvoiceTaxItem!]
total Float!
transactions TransactionList!
updatedAt Date

InvoiceDiscount

Fields

Name	Description
amount Float!
description String!

InvoiceExport

Fields

Name	Description
content String!

InvoiceItem

Fields

Name	Description
description String!
price Float!
quantity Float!
unitPrice Float!

InvoiceList

Fields

Name	Description
count Int!
cursor String
items [InvoiceListItem!]!
total Int!

InvoiceListItem

Fields

Name	Description
billingPeriodEnd Date!
billingPeriodStart Date!
buyer Billing!
createdAt Date
creditNotes CreditNoteList!
currency Currency!
customer Customer!
discount InvoiceDiscount
dueDate Date!
id ID!
items [InvoiceItem!]!
locale String
metadata JSON
number String!
paymentDate Date
paymentTermDays Int
seller Billing!
subtotal Float!
taxes [InvoiceTaxItem!]
total Float!
transactions TransactionList!
updatedAt Date

InvoicePreview

Fields

Name	Description
content String!

InvoiceTaxItem

Fields

Name	Description
amount Float!
description String!
rate Float!

License

Fields

Name	Description
activations Int
activationsLeft Int
code String
createdAt Date
customer Customer!
expirationDate Date
id ID!
licenseUser LicenseUser
metadata JSON
status LicenseStatus!
subscription Subscription!
units [String!]
updatedAt Date

LicenseList

Fields

Name	Description
count Int!
cursor String
items [License!]!
total Int!

LicenseUser

Fields

Name	Description
createdAt Date
customer Customer!
id ID!
licenses LicenseList!
metadata JSON
name String!
updatedAt Date

LicenseUserList

Fields

Name	Description
count Int!
cursor String
items [LicenseUser!]!
total Int!

Licensing

Fields

Name	Description
codeLength Int
codeStrategy LicensingCodeStrategy!
expirationDate Date
isActive Boolean
maxActivations Int
maxDuration Timeframe

Member

Fields

Name	Description
account Account!
customer Customer
email String
id ID!
name String!
role MemberRole!

MemberInvite

Fields

Name	Description
customer Customer
email String!
role MemberRole!

MemberInviteList

Fields

Name	Description
count Int!
cursor String
items [MemberInvite!]!
total Int!

MemberList

Fields

Name	Description
count Int!
cursor String
items [Member!]!
total Int!

PaymentMethod

Fields

Name	Description
externalId String
lastDigits String
metadata JSON
providerName PaymentProviderName
type PaymentMethodType!

PaymentProvider

Fields

Name	Description
config JSON
name PaymentProviderName!

PaymentSession

Fields

Name	Description
stripe StripePaymentSession

Person

Fields

Name	Description
email String!
firstName String!
lastName String!
metadata JSON
settings PersonSettings

PersonCustomerPortalSettings

Fields

Name	Description
isActive Boolean

PersonEmailSettings

Fields

Name	Description
invoices Boolean
payments Boolean

PersonSettings

Fields

Name	Description
customerPortal PersonCustomerPortalSettings
email PersonEmailSettings

Plan

Fields

Name	Description
billingDay Int
billingTerms BillingTerms
cancellationNotice Timeframe
endDate Date
freeTrial Timeframe
freeTrialEndDate Date
freeTrialStartDate Date
lastCancellationDate Date
maxDuration Timeframe
paymentTerms Timeframe
recurrency Timeframe!
renewalDate Date
startDate Date

PriceEstimation

Fields

Name	Description
couponCode String
currency Currency!
discountAmount Float!
subtotalAmount Float!
taxAmount Float!
totalAmount Float!

Pricing

Fields

Name	Description
chargeOnce Boolean
description String
price Float
strategy PricingStrategy!
tiers [PricingTier!]!
type PricingType!
unit String

PricingTier

Fields

Name	Description
from Float!
price Float!
to Int

Product

Fields

Name	Description
addons ProductList!
canDowngradeTo ProductList!
canUpgradeTo ProductList!
capabilities [ProductCapability!]
createdAt Date
currency Currency!
id ID!
isActive Boolean!
licensing Licensing
metadata JSON
name String!
nextProduct Product
plan Plan!
pricing [Pricing!]!
sku String!
subscriptions SubscriptionList!
taxRateCode TaxRateCode
updatedAt Date

ProductCapability

Fields

Name	Description
isActive Boolean!
name String!
usageLimit [SubscriptionUsage]

ProductCapabilitySettings

Fields

Name	Description
description String!
name String!
type String!

ProductList

Fields

Name	Description
count Int!
cursor String
items [Product!]!
total Int!

PublicApp

Fields

Name	Description
categories [String!]
createdAt Date
description String
events [String!]
id ID!
isInstalled Boolean!
logoUrl String
name String!
pageContent String
privacyUrl String
scopes [Scope!]
tosUrl String

PublicAppList

Fields

Name	Description
count Int!
cursor String
items [PublicApp!]!
total Int!

StripePaymentSession

Fields

Name	Description
clientSecret String!
publishableKey String!
stripeAccountId String!
stripeCustomerId String!

SubscriptionList

Fields

Name	Description
count Int!
cursor String
items [Subscription!]!
total Int!

SubscriptionUsage

Fields

Name	Description
amount Float!
unit String!

TaxId

Fields

Name	Description
countryCode String
type TaxIdType!
value String!

Timeframe

Fields

Name	Description
amount Float
unit TimeUnit

Transaction

Fields

Name	Description
amount Float!
createdAt Date!
creditNote CreditNote
currency Currency!
customer Customer!
id ID!
invoice Invoice
metadata JSON
paymentMethod PaymentMethod!
reference String
type TransactionType!
updatedAt Date

TransactionList

Fields

Name	Description
count Int!
cursor String
items [Transaction!]!
total Int!

User

Fields

Name	Description
currency Currency
email String!
firstName String
id ID!
lastName String
locale String
memberships MemberList!	Arguments Name Description filters FilterInput
theme String

Webhook

Fields

Name	Description
endpoint String!
events [String!]!
headers JSON
isActive Boolean

WebhookApiKeyAuthentication

Fields

Name	Description
keyName String!
keyValue String!

WebhookAuthentication

Fields

Name	Description
apiKeyAuthentication WebhookApiKeyAuthentication
basicAuthentication WebhookBasicAuthentication
type WebhookAuthentication!

WebhookBasicAuthentication

Fields

Name	Description
password String!
username String!