Input objects

_

Arguments

Name	Description
_ Boolean

AcceptMemberInviteInput

Arguments

Name	Description
accountId ID!
userId ID!

AccountBillingSettingsInput

Arguments

Name	Description
customTaxRate CustomTaxRateInput
footerText String
logoUrl String
numberingFormat AccountBillingSettingsNumberingFormatInput
taxSchemes [String!]

AccountBillingSettingsNumberingFormatInput

Arguments

Name	Description
creditNote String
invoice String

AccountMetadataFieldInput

Arguments

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

AccountMetadataOptionFieldInput

Arguments

Name	Description
label String!
value String!

AccountMetadataSettingsInput

Arguments

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

AccountPaymentMethodSettingsInput

Arguments

Name	Description
isActive Boolean
providerName PaymentProviderName!
type PaymentMethodType!

AccountPaymentSettingsInput

Arguments

Name	Description
paymentMethods [AccountPaymentMethodSettingsInput!]

AccountSettingsInput

Arguments

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

AccountThemeSettingsInput

Arguments

Name	Description
dark AccountThemesInput
light AccountThemesInput

AccountThemesInput

Arguments

Name	Description
logoUrl String

ActivateLicenseInput

Arguments

Name	Description
code String!
metadata JSON
subscriptionId ID!

AddAccountDomainInput

Arguments

Name	Description
name String!

AddPaymentMethodInput

Arguments

Name	Description
customerId ID!
externalId String
metadata JSON
providerName PaymentProviderName
type PaymentMethodType!

BillingInput

Arguments

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

CancelSubscriptionInput

Arguments

Name	Description
applyCancellationNow Boolean
applyProratedChargesNow Boolean

CreateAccountInput

Arguments

Name	Description
billing BillingInput
isProduction Boolean
metadata JSON
name String!
settings AccountSettingsInput

CreateApiClientInput

Arguments

Name	Description
redirectUrls [String!]
scopes [Scope!]
type String!

CreateAppInput

Arguments

Name	Description
name String!

CreateCreditNoteInput

Arguments

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

CreateCustomerInput

Arguments

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

CreateCustomerSessionInput

Arguments

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

CreateDiscountInput

Arguments

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

CreateInvoiceInput

Arguments

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

CreateLicenseInput

Arguments

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

CreateLicenseUserInput

Arguments

Name	Description
customerId ID!
metadata JSON
name String!

CreateProductInput

Arguments

Name	Description
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

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

CreateTransactionInput

Arguments

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

CreateWebhookInput

Arguments

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

CreditNoteExportInput

Arguments

Name	Description
ids [ID!]!

CustomTaxRateInput

Arguments

Name	Description
code String!
description String!
rate Float!

DowngradeSubscriptionInput

Arguments

Name	Description
applyProratedChargesNow Boolean
productId ID!

FilterInput

Arguments

Name	Description
cursor String
filters JSON
keywords String
limit Int
sort SortOrder

InstallAppInput

Arguments

Name	Description
config JSON

InviteMemberInput

Arguments

Name	Description
customerId ID
email String!
role MemberRole!

InvoiceDiscountInput

Arguments

Name	Description
amount Float!
description String!

InvoiceExportInput

Arguments

Name	Description
ids [ID!]!

InvoiceItemInput

Arguments

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

InvoiceTaxItemInput

Arguments

Name	Description
amount Float!
description String!
rate Float!

LicensingInput

Arguments

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

PaymentProviderInput

Arguments

Name	Description
config JSON
name PaymentProviderName!

PersonCustomerPortalSettingsInput

Arguments

Name	Description
isActive Boolean

PersonEmailSettingsInput

Arguments

Name	Description
invoices Boolean
payments Boolean

PersonInput

Arguments

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

PersonSettingsInput

Arguments

Name	Description
customerPortal PersonCustomerPortalSettingsInput
email PersonEmailSettingsInput

PlanInput

Arguments

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

PriceEstimationInput

Arguments

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

PricingInput

Arguments

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

ProductCapabilityInput

Arguments

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

ProductCapabilitySettingsInput

Arguments

Name	Description
description String!
name String!
type String!

RemovePaymentMethodInput

Arguments

Name	Description
customerId ID!

SubscriptionUsageInput

Arguments

Name	Description
amount Float!
unit String!

TaxIdInput

Arguments

Name	Description
countryCode String
type TaxIdType!
value String!

TierInput

Arguments

Name	Description
from Int!
price Float!
to Int

TimeframeInput

Arguments

Name	Description
amount Float
unit TimeUnit

UpdateAccountInput

Arguments

Name	Description
billing BillingInput
isProduction Boolean
metadata JSON
name String
settings AccountSettingsInput

UpdateApiClientInput

Arguments

Name	Description
redirectUrls [String!]
scopes [Scope!]
secret String

UpdateAppInput

Arguments

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

UpdateCustomerInput

Arguments

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

UpdateCustomerSessionInput

Arguments

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

UpdateDiscountInput

Arguments

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

UpdateLicenseInput

Arguments

Name	Description
code String
licenseUserId ID
metadata JSON
status LicenseStatusInput

UpdateLicenseUserInput

Arguments

Name	Description
metadata JSON
name String!

UpdatePaymentMethodInput

Arguments

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

UpdateProductInput

Arguments

Name	Description
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

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

UpdateSubscriptionProductInput

Arguments

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

UpdateUserInput

Arguments

Name	Description
currency Currency
email String
firstName String
lastName String
locale String
theme String

UpdateWebhookInput

Arguments

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

UpgradeSubscriptionInput

Arguments

Name	Description
applyProratedChargesNow Boolean
productId ID!

WebhookApiKeyAuthenticationInput

Arguments

Name	Description
keyName String!
keyValue String!

WebhookAuthenticationInput

Arguments

Name	Description
apiKeyAuthentication WebhookApiKeyAuthenticationInput
basicAuthentication WebhookBasicAuthenticationInput
type AuthenticationType!

WebhookBasicAuthenticationInput

Arguments

Name	Description
password String!
username String!