Type aliases
Addon
Addon
: { billingId
?: string | null; description
: string; displayName
: string; entitlements
: PackageEntitlement[]; id
: string; metadata
?: Metadata | null; pricePoints
: Price[]; pricingType
?: PricingType | null }Type declaration
Optional billingId?: string | null
description: string
displayName: string
id: string
Optional metadata?: Metadata | null
pricePoints: Price[]
Optional pricingType?: PricingType | null
Address
Address: { addressLine1?: string; addressLine2?: string; city?: string; country?: string; phoneNumber?: string; postalCode?: string; state?: string }
Type declaration
Optional addressLine1?: string
Optional addressLine2?: string
Optional city?: string
Optional country?: string
Optional phoneNumber?: string
Optional postalCode?: string
Optional state?: string
ApplySubscription
Apply
Subscription
: { addons
?: SubscriptionAddon[]; billableFeatures
?: BillableFeature[]; billingCountryCode
?: string; billingId
?: string; billingInformation
?: SubscriptionBillingInfo; billingPeriod
?: BillingPeriod; customerId
: string; metadata
?: Metadata | null; paymentMethodId
?: string; planId
: string; promotionCode
?: string; resourceId
?: string; skipTrial
?: boolean; startDate
?: Date; unitQuantity
?: number }Type declaration
Optional billingCountryCode?: string
Optional billingId?: string
customerId: string
Optional metadata?: Metadata | null
Optional paymentMethodId?: string
planId: string
Optional promotionCode?: string
Optional resourceId?: string
Optional skipTrial?: boolean
Optional startDate?: Date
Optional unitQuantity?: number
BaseEntitlement
Type declaration
hasAccess: boolean
isFallback: boolean
BasePlan
BasePlan: { displayName: string; id: string }
Type declaration
displayName: string
id: string
BillableFeature
BillableFeature: { featureId: string; quantity: number }
Type declaration
featureId: string
quantity: number
BillingAddress
BillingAddress: { city?: InputMaybe<Scalars["String"]>; country?: InputMaybe<Scalars["String"]>; line1?: InputMaybe<Scalars["String"]>; line2?: InputMaybe<Scalars["String"]>; postalCode?: InputMaybe<Scalars["String"]>; state?: InputMaybe<Scalars["String"]> }
Type declaration
Optional city?: InputMaybe<Scalars["String"]>
Optional country?: InputMaybe<Scalars["String"]>
Optional line1?: InputMaybe<Scalars["String"]>
Optional line2?: InputMaybe<Scalars["String"]>
Optional postalCode?: InputMaybe<Scalars["String"]>
Optional state?: InputMaybe<Scalars["String"]>
BillingInfo
Billing
Info
: { billingAddress
?: Address; currency
?: Currency; customerName
?: string; invoiceCustomFields
?: Record<string, string>; language
?: string; metadata
?: Metadata | null; paymentMethodId
?: string; shippingAddress
?: Address; taxIds
?: TaxExempt[]; timezone
?: string }Type declaration
Optional billingAddress?: Address
Optional currency?: Currency
Optional customerName?: string
Optional invoiceCustomFields?: Record<string, string>
Optional language?: string
Optional metadata?: Metadata | null
Optional paymentMethodId?: string
Optional shippingAddress?: Address
Optional taxIds?: TaxExempt[]
Optional timezone?: string
BooleanEntitlementFallback
BooleanEntitlementFallback: { hasAccess: boolean }
BooleanEntitlementOptions
Type declaration
Optional shouldTrack?: boolean
CancelSubscription
Type declaration
Optional endDate?: Date
subscriptionId: string
CancelSubscriptionScheduledUpdates
CancelSubscriptionScheduledUpdates: { status?: SubscriptionScheduleStatus.Scheduled | SubscriptionScheduleStatus.PendingPayment; subscriptionId: string }
Type declaration
Optional status?: SubscriptionScheduleStatus.Scheduled | SubscriptionScheduleStatus.PendingPayment
subscriptionId: string
CheckoutOptions
CheckoutOptions: { allowPromoCodes?: boolean; allowTaxIdCollection?: boolean; cancelUrl: string; collectBillingAddress?: boolean; collectPhoneNumber?: boolean; referenceId?: string; successUrl: string }
Type declaration
Optional allowPromoCodes?: boolean
Optional allowTaxIdCollection?: boolean
cancelUrl: string
Optional collectBillingAddress?: boolean
Optional collectPhoneNumber?: boolean
Optional referenceId?: string
successUrl: string
ClientConfiguration
Client
Configuration
: { apiKey
: string; baseEdgeUri
?: string; baseUri
?: string; enableEdge
?: boolean; entitlementsFallback
?: EntitlementsFallback; logConfiguration
?: LogConfiguration; realtimeUpdatesEnabled
?: boolean; redis
?: StiggRedisOptions; wsUrl
?: string }Type declaration
apiKey: string
Optional baseEdgeUri?: string
Optional baseUri?: string
Optional enableEdge?: boolean
Optional realtimeUpdatesEnabled?: boolean
Optional redis?: StiggRedisOptions
Optional wsUrl?: string
Coupon
Coupon
: { description
?: string | null; discountValue
: number; id
: string; metadata
?: Metadata | null; name
: string }Type declaration
Optional description?: string | null
discountValue: number
id: string
Optional metadata?: Metadata | null
name: string
CreateCustomer
Create
Customer
: { billingId
?: string; billingInfo
?: BillingInfo; couponId
?: string; customerId
?: string; email
?: string; excludeFromExperiment
?: boolean; metadata
?: Metadata | null; name
?: string; shouldSyncFree
?: boolean }Type declaration
Optional billingId?: string
Optional billingInfo?: BillingInfo
Optional couponId?: string
Optional customerId?: string
Optional email?: string
Optional excludeFromExperiment?: boolean
Optional metadata?: Metadata | null
Optional name?: string
Optional shouldSyncFree?: boolean
CreateSubscriptionParams
Type declaration
Optional awaitPaymentConfirmation?: boolean
Optional id?: string
Optional metadata?: Metadata | null
planId: string
Optional promotionCode?: string
Optional resourceId?: string
Optional skipTrial?: boolean
Optional startDate?: Date
Optional unitQuantity?: number
CreateUsageMeasurement
Create
Usage
Measurement
: { customerId
: string; featureId
: string; resourceId
?: string; updateBehavior
?: UsageUpdateBehavior; value
: number }Type declaration
customerId: string
featureId: string
Optional resourceId?: string
value: number
CustomerResource
CustomerResource: { id: string }
CustomerState
Customer
State
: Omit<FullCustomer, "getActiveSubscriptions" | "getActivePromotionalEntitlements" | "getActiveTrials">DateRange
DateRange: { end?: Date; start?: Date }
Type declaration
Optional end?: Date
Optional start?: Date
EntitlementFeature
Type declaration
id: string
Optional isMetered?: boolean
Optional units?: string
Optional unitsPlural?: string
EntitlementUsageUpdatedFragment
EntitlementUsageUpdatedFragment: { __typename?: "UsageUpdated"; entitlement: { __typename?: "Entitlement" } & EntitlementFragment; usage: { __typename?: "UsageMeasurementUpdated" } & UsageUpdatedFragment }
Type declaration
Optional __typename?: "UsageUpdated"
entitlement: { __typename?: "Entitlement" } & EntitlementFragment
usage: { __typename?: "UsageMeasurementUpdated" } & UsageUpdatedFragment
EntitlementsFallback
EntitlementsFallback: {}
EntitlementsUpdatedPayloadFragment
EntitlementsUpdatedPayloadFragment: { __typename?: "EntitlementsUpdated"; customerId: string; entitlements: ({ __typename?: "Entitlement" } & EntitlementFragment)[]; resourceId?: string | null }
Type declaration
Optional __typename?: "EntitlementsUpdated"
customerId: string
entitlements: ({ __typename?: "Entitlement" } & EntitlementFragment)[]
Optional resourceId?: string | null
EstimateSubscription
Estimate
Subscription
: { addons
?: SubscriptionAddon[]; billableFeatures
?: BillableFeature[]; billingCountryCode
?: string; billingInformation
?: SubscriptionBillingInfo; billingPeriod
?: BillingPeriod; customerId
: string; planId
: string; promotionCode
?: string; resourceId
?: string; skipTrial
?: boolean; startDate
?: Date; unitQuantity
?: number }Type declaration
Optional billingCountryCode?: string
customerId: string
planId: string
Optional promotionCode?: string
Optional resourceId?: string
Optional skipTrial?: boolean
Optional startDate?: Date
Optional unitQuantity?: number
EstimateSubscriptionUpdate
Estimate
Subscription
Update
: { addons
?: SubscriptionAddon[]; billableFeatures
?: BillableFeature[]; promotionCode
?: string; subscriptionId
: string; unitQuantity
?: number }Type declaration
Optional promotionCode?: string
subscriptionId: string
Optional unitQuantity?: number
EventDimensionValue
EventDimensionValue: string | number | boolean
ExperimentInfo
Experiment
Info
: { groupName
: string; groupType
?: ExperimentGroupType | null; id
: string; name
: string }Type declaration
groupName: string
id: string
name: string
FetchUsageHistory
FetchUsageHistory: { customerId: string; endDate?: Date; featureId: string; resourceId?: string; startDate: Date }
Type declaration
customerId: string
Optional endDate?: Date
featureId: string
Optional resourceId?: string
startDate: Date
FullEntitlementFeature
Full
Entitlement
Feature
: { description
?: string; displayName
: string; featureType
: FeatureType; id
: string; isMetered
?: boolean; metadata
?: Record<string, string>; meterType
?: Fluctuating | Incremental | None; units
?: string; unitsPlural
?: string }Type declaration
Optional description?: string
displayName: string
id: string
Optional isMetered?: boolean
Optional metadata?: Record<string, string>
Optional units?: string
Optional unitsPlural?: string
FullPromotionalEntitlement
Type declaration
Optional expiresAt?: Date
hasExpirationDate: boolean
Optional hasUnlimitedUsage?: boolean | null
isVisible: boolean
usageLimit: number
FullSubscription
Type declaration
Optional billingId?: string
Optional billingLinkUrl?: string
Optional cancellationDate?: Date
Optional crmId?: string
Optional currentBillingPeriodEnd?: Date
Optional effectiveEndDate?: Date
Optional endDate?: Date
Optional experimentInfo?: ExperimentInfo | null
futureUpdates: SubscriptionFutureUpdateDataFragment[]
id: string
Optional metadata?: Metadata | null
paymentCollection: PaymentCollection
startDate: Date
totalPrice: TotalPriceFragment | null | undefined
Optional trialEndDate?: Date
FullSubscriptionAddon
Full
Subscription
Addon
: { addon
: Addon; quantity
: number }GetActiveSubscriptions
GetActiveSubscriptions: { customerId: string; resourceId?: string | string[] }
Type declaration
customerId: string
Optional resourceId?: string | string[]
GetBooleanEntitlement
Type declaration
customerId: string
featureId: string
Optional resourceId?: string
GetMeteredEntitlement
Type declaration
customerId: string
featureId: string
Optional resourceId?: string
GetNumericEntitlement
Type declaration
customerId: string
featureId: string
Optional resourceId?: string
GetPaywall
GetPaywall: { billingCountryCode?: string; customerId?: string; fetchAllCountriesPrices?: boolean; productId?: string; resourceId?: string }
Type declaration
Optional billingCountryCode?: string
Optional customerId?: string
Optional fetchAllCountriesPrices?: boolean
Optional productId?: string
Optional resourceId?: string
ImmediateSubscriptionPreviewInvoice
ImportCustomer
Import
Customer
: { billingId
?: string; customerId
?: string; email
?: string; metadata
?: Metadata | null; name
?: string; paymentMethodId
?: string }Type declaration
Optional billingId?: string
Optional customerId?: string
Optional email?: string
Optional metadata?: Metadata | null
Optional name?: string
Optional paymentMethodId?: string
ImportSubscription
Import
Subscription
: { billingId
?: string; billingPeriod
?: BillingPeriod; customerId
: string; metadata
?: Metadata; planId
: string; resourceId
?: string; startDate
?: Date; unitQuantity
?: number }Type declaration
Optional billingId?: string
customerId: string
Optional metadata?: Metadata
planId: string
Optional resourceId?: string
Optional startDate?: Date
Optional unitQuantity?: number
MeteredEntitlementFallback
MeteredEntitlementFallback: { hasAccess: boolean; isUnlimited?: boolean; usageLimit?: number }
Type declaration
hasAccess: boolean
Optional isUnlimited?: boolean
Optional usageLimit?: number
MeteredEntitlementOptions
Type declaration
Optional requestedUsage?: number
Optional shouldTrack?: boolean
MigrateSubscriptionToLatest
Money
Money: { amount: number; currency: string }
Type declaration
amount: number
currency: string
NumericEntitlementFallback
NumericEntitlementFallback: { hasAccess: boolean; isUnlimited?: boolean; value?: number }
Type declaration
hasAccess: boolean
Optional isUnlimited?: boolean
Optional value?: number
NumericEntitlementOptions
Type declaration
Optional shouldTrack?: boolean
PackageEntitlement
Package
Entitlement
: { displayNameOverride
?: PackageEntitlementFragment["displayNameOverride"]; feature
: FullEntitlementFeature; hasUnlimitedUsage
?: boolean | null; hiddenFromWidgets
?: PackageEntitlementFragment["hiddenFromWidgets"]; resetPeriod
?: EntitlementResetPeriod | null; usageLimit
: number }Type declaration
Optional displayNameOverride?: PackageEntitlementFragment["displayNameOverride"]
Optional hasUnlimitedUsage?: boolean | null
Optional hiddenFromWidgets?: PackageEntitlementFragment["hiddenFromWidgets"]
usageLimit: number
PaymentMethodDetails
PaymentMethodDetails: { expirationMonth?: number | null; expirationYear?: number | null; last4Digits?: string | null }
Type declaration
Optional expirationMonth?: number | null
Optional expirationYear?: number | null
Optional last4Digits?: string | null
PaywallConfiguration
PaywallConfiguration: Omit<PaywallConfigurationFragment, "__typename">
PaywallCurrency
PaywallCurrency: Omit<PaywallCurrencyFragment, "__typename">
Plan
Type declaration
Optional basePlan?: BasePlan
Optional billingId?: string | null
compatibleAddons: Addon[]
Optional defaultTrialConfig?: DefaultTrialConfig | null
Optional description?: string | null
displayName: string
id: string
Optional metadata?: Metadata | null
order: number
pricePoints: Price[]
Optional pricingType?: PricingType | null
PreviewSubscription
Type declaration
Optional billingCountryCode?: string
customerId: string
planId: string
Optional promotionCode?: string
Optional resourceId?: string
Optional startDate?: Date
Optional unitQuantity?: number
Price
Price
: { amount
?: number | null; billingCountryCode
?: string | null; billingId
?: string | null; billingPeriod
: BillingPeriod; currency
: Currency; feature
?: { description
?: string | null; displayName
: string; featureId
: string; unitQuantity
?: number | null; units
?: string | null; unitsPlural
?: string | null } | null; maxUnitQuantity
?: number | null; minUnitQuantity
?: number | null; pricingModel
: BillingModel; tiers
?: PriceTierFragment[] | null; tiersMode
: TiersMode | null | undefined }Type declaration
Optional amount?: number | null
Optional billingCountryCode?: string | null
Optional billingId?: string | null
Optional feature?: { description?: string | null; displayName: string; featureId: string; unitQuantity?: number | null; units?: string | null; unitsPlural?: string | null } | null
Optional maxUnitQuantity?: number | null
Optional minUnitQuantity?: number | null
Optional tiers?: PriceTierFragment[] | null
tiersMode: TiersMode | null | undefined
PriceTierInput
PriceTierInput: { unitPrice: MoneyInputDto; upTo: Scalars["Float"] }
Type declaration
unitPrice: MoneyInputDto
upTo: Scalars["Float"]
Product
Product
: { description
?: string | null; displayName
?: string | null; downgradePlan
?: Pick<Plan, "id" | "displayName">; id
: string; metadata
?: Metadata | null }Type declaration
Optional description?: string | null
Optional displayName?: string | null
Optional downgradePlan?: Pick<Plan, "id" | "displayName">
id: string
Optional metadata?: Metadata | null
PromotionalEntitlement
Type declaration
Optional expiresAt?: Date
hasExpirationDate: boolean
Optional hasUnlimitedUsage?: boolean | null
isVisible: boolean
usageLimit: number
ProvisionSubscription
Provision
Subscription
: { addons
?: SubscriptionAddon[]; awaitPaymentConfirmation
?: boolean; billableFeatures
?: BillableFeature[]; billingCountryCode
?: string; billingId
?: string; billingInformation
?: SubscriptionBillingInfo; billingPeriod
?: BillingPeriod; checkoutOptions
?: CheckoutOptions; customerId
: string; id
?: string; metadata
?: Metadata | null; planId
: string; promotionCode
?: string; resourceId
?: string; skipTrial
?: boolean; startDate
?: Date; unitQuantity
?: number }Type declaration
Optional awaitPaymentConfirmation?: boolean
Optional billingCountryCode?: string
Optional billingId?: string
customerId: string
Optional id?: string
Optional metadata?: Metadata | null
planId: string
Optional promotionCode?: string
Optional resourceId?: string
Optional skipTrial?: boolean
Optional startDate?: Date
Optional unitQuantity?: number
ProvisionSubscriptionResult
Type declaration
Optional checkoutUrl?: string | null
ReportEvent
Report
Event
: { customerId
: string; dimensions
?: Record<string, EventDimensionValue>; eventName
: string; idempotencyKey
: string; resourceId
?: string; timestamp
?: Date }Type declaration
customerId: string
eventName: string
idempotencyKey: string
Optional resourceId?: string
Optional timestamp?: Date
ReportUsage
Report
Usage
: { customerId
: string; featureId
: string; resourceId
?: string; updateBehavior
?: UsageUpdateBehavior; value
: number }Type declaration
customerId: string
featureId: string
Optional resourceId?: string
value: number
ReportUsageAck
ReportUsageAck: { measurementId: string }
SlimCustomer
Slim
Customer
: { billingId
?: string; createdAt
: Date; email
?: string; id
: string; metadata
?: Metadata | null; name
?: string; updatedAt
: Date }Type declaration
Optional billingId?: string
createdAt: Date
Optional email?: string
id: string
Optional metadata?: Metadata | null
Optional name?: string
updatedAt: Date
Subscription
Type declaration
addonIds: string[]
Optional billingId?: string
Optional billingLinkUrl?: string
customerId: string
Optional effectiveEndDate?: Date
Optional experimentInfo?: ExperimentInfo | null
id: string
Optional metadata?: Metadata | null
paymentCollection: PaymentCollection
planId: string
totalPrice: TotalPriceFragment | null | undefined
SubscriptionAddon
SubscriptionAddon: { addonId: string; quantity?: number }
Type declaration
addonId: string
Optional quantity?: number
SubscriptionBillingInfo
Subscription
Billing
Info
: { billingAddress
?: BillingAddress; metadata
?: Metadata | null; taxPercentage
?: number; taxRateIds
?: string[] }Type declaration
Optional metadata?: Metadata | null
Optional taxPercentage?: number
Optional taxRateIds?: string[]
SubscriptionInvoiceFragment
SubscriptionInvoiceFragment: { __typename?: "SubscriptionInvoice"; billingId: string; createdAt: any; errorMessage?: string | null; paymentSecret?: string | null; paymentUrl?: string | null; requiresAction: boolean; status: SubscriptionInvoiceStatus; updatedAt: any }
Type declaration
Optional __typename?: "SubscriptionInvoice"
billingId: string
createdAt: any
Optional errorMessage?: string | null
Optional paymentSecret?: string | null
Optional paymentUrl?: string | null
requiresAction: boolean
status: SubscriptionInvoiceStatus
updatedAt: any
SubscriptionPreviewCredits
Subscription
Preview
Credits
: { initial
: Money; remaining
: Money; used
: Money }SubscriptionPreviewDiscount
Type declaration
Optional durationInMonths?: number
value: number
SubscriptionPreviewInvoice
SubscriptionPreviewProration
Subscription
Preview
Proration
: { credit
: Money; debit
: Money; hasProrations
?: boolean; netAmount
: Money; prorationDate
: Date }Type declaration
Optional hasProrations?: boolean
netAmount: Money
prorationDate: Date
SubscriptionPreviewTaxDetails
SubscriptionPreviewTaxDetails: { displayName: string; inclusive: boolean; percentage: number }
Type declaration
displayName: string
inclusive: boolean
percentage: number
SubscriptionPrice
Subscription
Price
: Price & { grossAmount
: number }TaxExempt
TaxExempt: { type: string; value: string }
Type declaration
type: string
value: string
TransferSubscriptionInput
TransferSubscriptionInput: { customerId: Scalars["String"]; destinationResourceId: Scalars["String"]; sourceResourceId: Scalars["String"] }
Type declaration
customerId: Scalars["String"]
destinationResourceId: Scalars["String"]
sourceResourceId: Scalars["String"]
TrialedPlan
TrialedPlan: { planId: string; productId: string }
Type declaration
planId: string
productId: string
UpdateCustomer
Update
Customer
: { billingInfo
?: Omit<BillingInfo, "taxIds">; couponId
?: string | null; customerId
: string; email
?: string; metadata
?: Metadata | null; name
?: string }Type declaration
Optional billingInfo?: Omit<BillingInfo, "taxIds">
Optional couponId?: string | null
customerId: string
Optional email?: string
Optional metadata?: Metadata | null
Optional name?: string
UpdateSubscription
Type declaration
Optional awaitPaymentConfirmation?: boolean
Optional metadata?: Metadata | null
subscriptionId: string
Optional unitQuantity?: number
UsageHistoryPoint
UsageHistoryPoint: { date: Date; isResetPoint: boolean; value: number }
Type declaration
date: Date
isResetPoint: boolean
value: number
optional country of the address - in a valid ISO 3166-1 alpha-2 format