Skip to main content

Objects

Account

Fields

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

AccountAnalyticsSettings

Fields

NameDescription
dashboardId
String
isAvailableInGlobalDashboard
Boolean

AccountBillingSettings

Fields

NameDescription
customTaxRate
CustomTaxRate
footerText
String
logoUrl
String
numberingFormat
AccountBillingSettingsNumberingFormat
taxSchemes
[String!]

AccountBillingSettingsNumberingFormat

Fields

NameDescription
creditNote
String
invoice
String

AccountCapabilities

Fields

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

AccountDomainConfigSettings

Fields

NameDescription
hostname
String!
isVerified
Boolean!
verificationRecord
AccountDomainConfigVerificationSettings!

AccountDomainConfigVerificationSettings

Fields

NameDescription
name
String!
type
String!
value
String!

AccountDomainSettings

Fields

NameDescription
config
AccountDomainConfigSettings
name
String!

AccountList

Fields

NameDescription
count
Int!
cursor
String
items
[Account]!
total
Int!

AccountMetadataField

Fields

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

AccountMetadataOptionField

Fields

NameDescription
label
String!
value
String!

AccountMetadataSettings

Fields

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

AccountPaymentMethodSettings

Fields

NameDescription
isActive
Boolean!
providerName
PaymentProviderName!
type
PaymentMethodType!

AccountPaymentSettings

Fields

NameDescription
paymentMethods
[AccountPaymentMethodSettings!]
providers
[PaymentProvider!]

AccountSettings

Fields

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

AccountTheme

Fields

NameDescription
logoUrl
String

AccountThemeSettings

Fields

NameDescription
dark
AccountTheme
light
AccountTheme

AnalyticsSessionToken

Fields

NameDescription
dashboardId
String!
token
String!

ApiClient

Fields

NameDescription
id
ID!
redirectUrls
[String!]
scopes
[Scope!]
secret
String
type
String!

App

Fields

NameDescription
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

NameDescription
account
Account!
app
PublicApp!
createdAt
Date!
id
ID!

AppInstanceList

Fields

NameDescription
count
Int!
cursor
String
items
[AppInstance!]!
total
Int!

AppList

Fields

NameDescription
count
Int!
cursor
String
items
[App!]!
total
Int!

Billing

Fields

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

CreditNote

Fields

NameDescription
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

NameDescription
amount
Float!
description
String!

CreditNoteExport

Fields

NameDescription
content
String!

CreditNoteItem

Fields

NameDescription
description
String!
price
Float!
quantity
Float!
unitPrice
Float!

CreditNoteList

Fields

NameDescription
count
Int!
cursor
String
items
[CreditNoteListItem!]!
total
Int!

CreditNoteListItem

Fields

NameDescription
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

NameDescription
content
String!

CreditNoteTaxItem

Fields

NameDescription
amount
Float!
description
String!
rate
Float!

Customer

Fields

NameDescription
billing
Billing
capabilities
[ProductCapability!]
createdAt
Date
creditNotes
CreditNoteList!

Arguments

NameDescription
filters
FilterInput
currency
Currency
discountCoupons
DiscountCouponList!

Arguments

NameDescription
filters
FilterInput
id
ID!
invoices
InvoiceList!

Arguments

NameDescription
filters
FilterInput
licenseUsers
LicenseUserList!

Arguments

NameDescription
filters
FilterInput
locale
String
metadata
JSON
name
String!
paymentMethod
PaymentMethod
people
[Person!]
subscriptions
SubscriptionList!

Arguments

NameDescription
filters
FilterInput
transactions
TransactionList!

Arguments

NameDescription
filters
FilterInput
updatedAt
Date

CustomerList

Fields

NameDescription
count
Int!
cursor
String
items
[Customer!]!
total
Int!

CustomerSession

Fields

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

CustomerSessionProduct

Fields

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

CustomerSessionProductList

Fields

NameDescription
count
Int!
cursor
String
items
[CustomerSessionProduct!]!
total
Int!

CustomTaxRate

Fields

NameDescription
code
String!
description
String!
rate
Float!

Discount

Fields

NameDescription
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

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

DiscountCouponList

Fields

NameDescription
count
Int!
cursor
String
items
[DiscountCoupon!]!
total
Int!

DiscountList

Fields

NameDescription
count
Int!
cursor
String
items
[Discount!]!
total
Int!

Invoice

Fields

NameDescription
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

NameDescription
amount
Float!
description
String!

InvoiceExport

Fields

NameDescription
content
String!

InvoiceItem

Fields

NameDescription
description
String!
price
Float!
quantity
Float!
unitPrice
Float!

InvoiceList

Fields

NameDescription
count
Int!
cursor
String
items
[InvoiceListItem!]!
total
Int!

InvoiceListItem

Fields

NameDescription
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

NameDescription
content
String!

InvoiceTaxItem

Fields

NameDescription
amount
Float!
description
String!
rate
Float!

License

Fields

NameDescription
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

NameDescription
count
Int!
cursor
String
items
[License!]!
total
Int!

LicenseUser

Fields

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

LicenseUserList

Fields

NameDescription
count
Int!
cursor
String
items
[LicenseUser!]!
total
Int!

Licensing

Fields

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

Member

Fields

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

MemberInvite

Fields

NameDescription
customer
Customer
email
String!
role
MemberRole!

MemberInviteList

Fields

NameDescription
count
Int!
cursor
String
items
[MemberInvite!]!
total
Int!

MemberList

Fields

NameDescription
count
Int!
cursor
String
items
[Member!]!
total
Int!

PaymentMethod

Fields

NameDescription
externalId
String
lastDigits
String
metadata
JSON
providerName
PaymentProviderName
type
PaymentMethodType!

PaymentProvider

Fields

NameDescription
config
JSON
name
PaymentProviderName!

PaymentSession

Fields

NameDescription
stripe
StripePaymentSession

Person

Fields

NameDescription
email
String!
firstName
String!
lastName
String!
metadata
JSON
settings
PersonSettings

PersonCustomerPortalSettings

Fields

NameDescription
isActive
Boolean

PersonEmailSettings

Fields

NameDescription
invoices
Boolean
payments
Boolean

PersonSettings

Fields

NameDescription
customerPortal
PersonCustomerPortalSettings
email
PersonEmailSettings

Plan

Fields

NameDescription
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

NameDescription
couponCode
String
currency
Currency!
discountAmount
Float!
subtotalAmount
Float!
taxAmount
Float!
totalAmount
Float!

Pricing

Fields

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

PricingTier

Fields

NameDescription
from
Float!
price
Float!
to
Int

Product

Fields

NameDescription
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

NameDescription
isActive
Boolean!
name
String!
usageLimit
[SubscriptionUsage]

ProductCapabilitySettings

Fields

NameDescription
description
String!
name
String!
type
String!

ProductList

Fields

NameDescription
count
Int!
cursor
String
items
[Product!]!
total
Int!

PublicApp

Fields

NameDescription
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

NameDescription
count
Int!
cursor
String
items
[PublicApp!]!
total
Int!

StripePaymentSession

Fields

NameDescription
clientSecret
String!
publishableKey
String!
stripeAccountId
String!
stripeCustomerId
String!

SubscriptionList

Fields

NameDescription
count
Int!
cursor
String
items
[Subscription!]!
total
Int!

SubscriptionUsage

Fields

NameDescription
amount
Float!
unit
String!

TaxId

Fields

NameDescription
countryCode
String
type
TaxIdType!
value
String!

Timeframe

Fields

NameDescription
amount
Float
unit
TimeUnit

Transaction

Fields

NameDescription
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

NameDescription
count
Int!
cursor
String
items
[Transaction!]!
total
Int!

User

Fields

NameDescription
currency
Currency
email
String!
firstName
String
id
ID!
lastName
String
locale
String
memberships
MemberList!

Arguments

NameDescription
filters
FilterInput
theme
String

Webhook

Fields

NameDescription
endpoint
String!
events
[String!]!
headers
JSON
isActive
Boolean

WebhookApiKeyAuthentication

Fields

NameDescription
keyName
String!
keyValue
String!

WebhookAuthentication

Fields

NameDescription
apiKeyAuthentication
WebhookApiKeyAuthentication
basicAuthentication
WebhookBasicAuthentication
type
WebhookAuthentication!

WebhookBasicAuthentication

Fields

NameDescription
password
String!
username
String!