Skip to main content

Input objects

_

Arguments

NameDescription
_
Boolean

AcceptMemberInviteInput

Arguments

NameDescription
accountId
ID!
userId
ID!

AccountBillingSettingsInput

Arguments

NameDescription
customTaxRate
CustomTaxRateInput
footerText
String
logoUrl
String
numberingFormat
AccountBillingSettingsNumberingFormatInput
taxSchemes
[String!]

AccountBillingSettingsNumberingFormatInput

Arguments

NameDescription
creditNote
String
invoice
String

AccountMetadataFieldInput

Arguments

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

AccountMetadataOptionFieldInput

Arguments

NameDescription
label
String!
value
String!

AccountMetadataSettingsInput

Arguments

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

AccountPaymentMethodSettingsInput

Arguments

NameDescription
isActive
Boolean
providerName
PaymentProviderName!
type
PaymentMethodType!

AccountPaymentSettingsInput

Arguments

NameDescription
paymentMethods
[AccountPaymentMethodSettingsInput!]

AccountSettingsInput

Arguments

NameDescription
billing
AccountBillingSettingsInput
capabilities
[ProductCapabilitySettingsInput!]
metadata
AccountMetadataSettingsInput
payments
AccountPaymentSettingsInput
theme
AccountThemeSettingsInput

AccountThemeSettingsInput

Arguments

NameDescription
dark
AccountThemesInput
light
AccountThemesInput

AccountThemesInput

Arguments

NameDescription
logoUrl
String

ActivateLicenseInput

Arguments

NameDescription
code
String!
metadata
JSON
subscriptionId
ID!

AddAccountDomainInput

Arguments

NameDescription
name
String!

AddPaymentMethodInput

Arguments

NameDescription
customerId
ID!
externalId
String
metadata
JSON
providerName
PaymentProviderName
type
PaymentMethodType!

BillingInput

Arguments

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

CancelSubscriptionInput

Arguments

NameDescription
applyCancellationNow
Boolean
applyProratedChargesNow
Boolean

CreateAccountInput

Arguments

NameDescription
billing
BillingInput
isProduction
Boolean
metadata
JSON
name
String!
settings
AccountSettingsInput

CreateApiClientInput

Arguments

NameDescription
redirectUrls
[String!]
scopes
[Scope!]
type
String!

CreateAppInput

Arguments

NameDescription
name
String!

CreateCreditNoteInput

Arguments

NameDescription
amount
Float!
applyRefund
Boolean
customerId
ID!
description
String!
invoiceId
ID!
metadata
JSON

CreateCustomerInput

Arguments

NameDescription
billing
BillingInput
currency
Currency
locale
String
metadata
JSON
name
String!
paymentMethod
UpdatePaymentMethodInput
people
[PersonInput!]

CreateCustomerSessionInput

Arguments

NameDescription
couponCode
String
customer
CreateCustomerInput
customerId
ID
productId
ID
subscriptionId
ID
usage
[SubscriptionUsageInput!]

CreateDiscountInput

Arguments

NameDescription
amount
Float!
code
String
currency
Currency
expirationDate
Date
isActive
Boolean
maxDuration
TimeframeInput
maxPeriods
Int
maxRedemptions
Int
metadata
JSON
name
String!
type
DiscountType!

CreateInvoiceInput

Arguments

NameDescription
billingPeriodEnd
Date!
billingPeriodStart
Date!
currency
Currency
customerId
ID!
discount
InvoiceDiscountInput
dueDate
Date!
items
[InvoiceItemInput!]!
locale
String
metadata
JSON
paymentTermDays
Int

CreateLicenseInput

Arguments

NameDescription
licenseUserId
ID
metadata
JSON
status
LicenseStatusInput
subscriptionId
ID!
units
[String!]

CreateLicenseUserInput

Arguments

NameDescription
customerId
ID!
metadata
JSON
name
String!

CreateProductInput

Arguments

NameDescription
addons
[String!]
canDowngradeTo
[String!]
canUpgradeTo
[String!]
capabilities
[ProductCapabilityInput!]
currency
Currency
isActive
Boolean
licensing
LicensingInput
metadata
JSON
name
String!
nextProductId
String
plan
PlanInput
pricing
[PricingInput!]
sku
String!
taxRateCode
TaxRateCode

CreateSubscriptionInput

Arguments

NameDescription
couponCode
String
customerId
ID!
endDate
Date
isActive
Boolean
metadata
JSON
productId
ID!
startDate
Date
usage
[SubscriptionUsageInput!]

CreateTransactionInput

Arguments

NameDescription
amount
Float!
creditNoteId
ID
currency
Currency!
invoiceId
ID
metadata
JSON
reference
String
type
TransactionType!

CreateWebhookInput

Arguments

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

CreditNoteExportInput

Arguments

NameDescription
ids
[ID!]!

CustomTaxRateInput

Arguments

NameDescription
code
String!
description
String!
rate
Float!

DowngradeSubscriptionInput

Arguments

NameDescription
applyProratedChargesNow
Boolean
productId
ID!

FilterInput

Arguments

NameDescription
cursor
String
filters
JSON
keywords
String
limit
Int
sort
SortOrder

InstallAppInput

Arguments

NameDescription
config
JSON

InviteMemberInput

Arguments

NameDescription
customerId
ID
email
String!
role
MemberRole!

InvoiceDiscountInput

Arguments

NameDescription
amount
Float!
description
String!

InvoiceExportInput

Arguments

NameDescription
ids
[ID!]!

InvoiceItemInput

Arguments

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

InvoiceTaxItemInput

Arguments

NameDescription
amount
Float!
description
String!
rate
Float!

LicensingInput

Arguments

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

PaymentProviderInput

Arguments

NameDescription
config
JSON
name
PaymentProviderName!

PersonCustomerPortalSettingsInput

Arguments

NameDescription
isActive
Boolean

PersonEmailSettingsInput

Arguments

NameDescription
invoices
Boolean
payments
Boolean

PersonInput

Arguments

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

PersonSettingsInput

Arguments

NameDescription
customerPortal
PersonCustomerPortalSettingsInput
email
PersonEmailSettingsInput

PlanInput

Arguments

NameDescription
billingDay
Int
billingTerms
BillingTerms
cancellationNotice
TimeframeInput
endDate
Date
freeTrial
TimeframeInput
maxDuration
TimeframeInput
paymentTerms
TimeframeInput
recurrency
TimeframeInput
startDate
Date

PriceEstimationInput

Arguments

NameDescription
applyProratedChargesNow
Boolean
couponCode
String
customerId
ID!
productId
ID
subscriptionId
ID
usage
[SubscriptionUsageInput!]

PricingInput

Arguments

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

ProductCapabilityInput

Arguments

NameDescription
isActive
Boolean!
name
String!
usageLimit
[SubscriptionUsageInput]

ProductCapabilitySettingsInput

Arguments

NameDescription
description
String!
name
String!
type
String!

RemovePaymentMethodInput

Arguments

NameDescription
customerId
ID!

SubscriptionUsageInput

Arguments

NameDescription
amount
Float!
unit
String!

TaxIdInput

Arguments

NameDescription
countryCode
String
type
TaxIdType!
value
String!

TierInput

Arguments

NameDescription
from
Int!
price
Float!
to
Int

TimeframeInput

Arguments

NameDescription
amount
Float
unit
TimeUnit

UpdateAccountInput

Arguments

NameDescription
billing
BillingInput
isProduction
Boolean
metadata
JSON
name
String
settings
AccountSettingsInput

UpdateApiClientInput

Arguments

NameDescription
redirectUrls
[String!]
scopes
[Scope!]
secret
String

UpdateAppInput

Arguments

NameDescription
accountIds
[String!]
apiClient
UpdateApiClientInput
isActive
Boolean
logoUrl
String
name
String
privacyUrl
String
tosUrl
String
webhooks
UpdateWebhookInput

UpdateCustomerInput

Arguments

NameDescription
billing
BillingInput
currency
Currency
locale
String
metadata
JSON
name
String
paymentMethod
UpdatePaymentMethodInput
people
[PersonInput!]

UpdateCustomerSessionInput

Arguments

NameDescription
couponCode
String
customer
UpdateCustomerInput
isConfirmed
Boolean
productId
ID
subscriptionId
ID
usage
[SubscriptionUsageInput!]

UpdateDiscountInput

Arguments

NameDescription
amount
Float
code
String
currency
Currency
expirationDate
Date
isActive
Boolean
maxDuration
TimeframeInput
maxPeriods
Int
maxRedemptions
Int
metadata
JSON
name
String
type
DiscountType

UpdateLicenseInput

Arguments

NameDescription
code
String
licenseUserId
ID
metadata
JSON
status
LicenseStatusInput

UpdateLicenseUserInput

Arguments

NameDescription
metadata
JSON
name
String!

UpdatePaymentMethodInput

Arguments

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

UpdateProductInput

Arguments

NameDescription
addons
[String!]
applyToAllSubscriptions
Boolean
canDowngradeTo
[String!]
canUpgradeTo
[String!]
capabilities
[ProductCapabilityInput!]
currency
Currency
isActive
Boolean
licensing
LicensingInput
metadata
JSON
name
String
nextProductId
String
plan
PlanInput
pricing
[PricingInput!]
sku
String
taxRateCode
TaxRateCode

UpdateSubscriptionInput

Arguments

NameDescription
applyProratedChargesNow
Boolean
couponCode
String
metadata
JSON
product
UpdateSubscriptionProductInput
usage
[SubscriptionUsageInput!]

UpdateSubscriptionProductInput

Arguments

NameDescription
addons
[String!]
canDowngradeTo
[String!]
canUpgradeTo
[String!]
capabilities
[ProductCapabilityInput!]
currency
Currency
licensing
LicensingInput
nextProductId
String
plan
PlanInput
pricing
[PricingInput!]

UpdateUserInput

Arguments

NameDescription
currency
Currency
email
String
firstName
String
lastName
String
locale
String
theme
String

UpdateWebhookInput

Arguments

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

UpgradeSubscriptionInput

Arguments

NameDescription
applyProratedChargesNow
Boolean
productId
ID!

WebhookApiKeyAuthenticationInput

Arguments

NameDescription
keyName
String!
keyValue
String!

WebhookAuthenticationInput

Arguments

NameDescription
apiKeyAuthentication
WebhookApiKeyAuthenticationInput
basicAuthentication
WebhookBasicAuthenticationInput
type
AuthenticationType!

WebhookBasicAuthenticationInput

Arguments

NameDescription
password
String!
username
String!