Options
All
  • Public
  • Public/Protected
  • All
Menu

@stigg/js-client-sdk - v3.81.0

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AddCompatibleAddonsToPlanInput

AddCompatibleAddonsToPlanInput: { id: Scalars["UUID"]; relationIds: Scalars["UUID"][] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationIds: Scalars["UUID"][]

    The ids of the relations.

Addon

Addon: { billingId?: string | null; dependencies?: DependencyAddon[]; description: string; displayName: string; entitlements: PackageEntitlement[]; hiddenFromWidgets?: PackageEntitlementFragment["hiddenFromWidgets"]; id: string; maxQuantity?: number; metadata?: Metadata | null; pricePoints: Price[]; pricingType?: PricingType | null }

Type declaration

AddonArchiveInput

AddonArchiveInput: { environmentId?: InputMaybe<Scalars["UUID"]>; refId: Scalars["String"] }

Archive addon input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • refId: Scalars["String"]

    Addon id

AddonAssociatedEntitiesInput

AddonAssociatedEntitiesInput: { environmentId: Scalars["String"]; refId: Scalars["String"] }

Query associated entities input

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • refId: Scalars["String"]

    Addon refId

AddonCreateInput

AddonCreateInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; awsMarketplacePlanDimension?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; dependencies?: InputMaybe<Scalars["String"][]>; description?: InputMaybe<Scalars["String"]>; displayName: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; maxQuantity?: InputMaybe<Scalars["Float"]>; pricingType?: InputMaybe<PricingType>; productId: Scalars["String"]; refId?: InputMaybe<Scalars["String"]>; status?: InputMaybe<PackageStatus> }

Input for creating an addon

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    The additional meta data of the package

  • Optional awsMarketplacePlanDimension?: InputMaybe<Scalars["String"]>

    The AWS marketplace plan dimension of the package

  • Optional billingId?: InputMaybe<Scalars["String"]>

    The unique identifier for the entity in the billing provider

  • Optional dependencies?: InputMaybe<Scalars["String"][]>

    List of addon ids this addon should be dependant on

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the package

  • displayName: Scalars["String"]

    The display name of the package

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional hiddenFromWidgets?: InputMaybe<WidgetType[]>

    List of hidden widgets of the package

  • Optional maxQuantity?: InputMaybe<Scalars["Float"]>

    The maximum quantity of this addon that can be added to a subscription

  • Optional pricingType?: InputMaybe<PricingType>

    The pricing type of the package

  • productId: Scalars["String"]

    The product id of the package

  • Optional refId?: InputMaybe<Scalars["String"]>

    The unique identifier for the entity

  • Optional status?: InputMaybe<PackageStatus>

    The status of the package

AddonDependencyFragment

AddonDependencyFragment: { __typename?: "Addon"; description?: string | null; displayName: string; id: any; refId: string }

Type declaration

  • Optional __typename?: "Addon"
  • Optional description?: string | null
  • displayName: string
  • id: any
  • refId: string

AddonFilter

AddonFilter: { and?: InputMaybe<AddonFilter[]>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; offer?: InputMaybe<AddonFilterOfferFilter>; or?: InputMaybe<AddonFilter[]>; pricingType?: InputMaybe<PricingTypeFilterComparison>; productId?: InputMaybe<StringFieldComparison>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<PackageStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

AddonFilterOfferFilter

AddonFilterOfferFilter: { and?: InputMaybe<AddonFilterOfferFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isDefault?: InputMaybe<BooleanFieldComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; offerId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<AddonFilterOfferFilter[]>; status?: InputMaybe<OfferStatusFilterComparison>; version?: InputMaybe<IntFieldComparison> }

Type declaration

AddonFragment

AddonFragment: { __typename?: "Addon"; additionalMetaData?: any | null; billingId?: string | null; dependencies?: ({ __typename?: "Addon" } & AddonDependencyFragment)[] | null; description?: string | null; displayName: string; entitlements?: ({ __typename?: "PackageEntitlement" } & PackageEntitlementFragment)[] | null; hiddenFromWidgets?: WidgetType[] | null; id: any; maxQuantity?: number | null; overagePrices?: ({ __typename?: "Price" } & OveragePriceFragment)[] | null; prices?: ({ __typename?: "Price" } & PriceFragment)[] | null; pricingType?: PricingType | null; refId: string }

Type declaration

  • Optional __typename?: "Addon"
  • Optional additionalMetaData?: any | null
  • Optional billingId?: string | null
  • Optional dependencies?: ({ __typename?: "Addon" } & AddonDependencyFragment)[] | null
  • Optional description?: string | null
  • displayName: string
  • Optional entitlements?: ({ __typename?: "PackageEntitlement" } & PackageEntitlementFragment)[] | null
  • Optional hiddenFromWidgets?: WidgetType[] | null
  • id: any
  • Optional maxQuantity?: number | null
  • Optional overagePrices?: ({ __typename?: "Price" } & OveragePriceFragment)[] | null
  • Optional prices?: ({ __typename?: "Price" } & PriceFragment)[] | null
  • Optional pricingType?: PricingType | null
  • refId: string

AddonSort

AddonSort: { direction: SortDirection; field: AddonSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

AddonUnArchiveInput

AddonUnArchiveInput: { environmentId?: InputMaybe<Scalars["UUID"]>; id: Scalars["String"] }

Un-archive addon input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • id: Scalars["String"]

    Add-on ID to unarchive

AddonUpdateInput

AddonUpdateInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; billingId?: InputMaybe<Scalars["String"]>; dependencies?: InputMaybe<Scalars["String"][]>; description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; id: Scalars["UUID"]; maxQuantity?: InputMaybe<Scalars["Float"]>; status?: InputMaybe<PackageStatus> }

Type declaration

Address

Address: { addressLine1?: InputMaybe<Scalars["String"]>; addressLine2?: InputMaybe<Scalars["String"]>; city?: InputMaybe<Scalars["String"]>; country?: InputMaybe<Scalars["String"]>; phoneNumber?: InputMaybe<Scalars["String"]>; postalCode?: InputMaybe<Scalars["String"]>; state?: InputMaybe<Scalars["String"]> }

Customers address

Type declaration

AggregatedEventsByCustomerInput

AggregatedEventsByCustomerInput: { aggregation: MeterAggregation; customerId?: InputMaybe<Scalars["String"]>; environmentId: Scalars["UUID"]; filters: MeterFilterDefinitionInput[] }

Input parameters for aggregating events by customer

Type declaration

ApiKeyFilter

ApiKeyFilter: { and?: InputMaybe<ApiKeyFilter[]>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<ApiKeyFilter[]> }

Type declaration

ApiKeySort

ApiKeySort: { direction: SortDirection; field: ApiKeySortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

AppStoreCredentialsInput

AppStoreCredentialsInput: { issuerId: Scalars["String"]; keyId: Scalars["String"]; privateKey: Scalars["String"]; sandboxEnvironment: Scalars["Boolean"] }

Input configuration for AppStore integration

Type declaration

  • issuerId: Scalars["String"]

    The issuer ID of key in App Store Connect

  • keyId: Scalars["String"]

    The key ID of key in App Store Connect

  • privateKey: Scalars["String"]

    The private key in App Store Connect (.p8 file content)

  • sandboxEnvironment: Scalars["Boolean"]

    Whether the application is in sandbox environment

AppStoreSubscriptionMappingInput

AppStoreSubscriptionMappingInput: { appStoreSubscriptionId: Scalars["String"]; planRefId: Scalars["String"] }

An App Store subscription mapping object

Type declaration

  • appStoreSubscriptionId: Scalars["String"]

    Product ID of the App Store subscription

  • planRefId: Scalars["String"]

    Ref ID of the Stigg plan

AppStoreSubscriptionsToPlansMappingInput

AppStoreSubscriptionsToPlansMappingInput: { appStoreSubscriptionMapping: AppStoreSubscriptionMappingInput[]; applicationId: Scalars["String"]; bundleId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]> }

Input for mapping App Store subscriptions to plans

Type declaration

  • appStoreSubscriptionMapping: AppStoreSubscriptionMappingInput[]

    Array of App Store subscription mappings

  • applicationId: Scalars["String"]

    ID of the App Store application

  • bundleId: Scalars["String"]

    Bundle ID of the App Store application

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

ApplySubscription

ApplySubscription: { addons?: CheckoutAddon[]; billableFeatures?: BillableFeature[]; billingCountryCode?: string; billingId?: string; billingInformation?: Omit<SubscriptionBillingInfo, "taxPercentage">; billingPeriod?: BillingPeriod; metadata?: Metadata | null; payingCustomerId?: string; paymentMethodId?: string; planId: string; promotionCode?: string; resourceId?: string; scheduleStrategy?: ScheduleStrategy; skipTrial?: boolean; startDate?: Date; unitQuantity?: number }

Type declaration

  • Optional addons?: CheckoutAddon[]
  • Optional billableFeatures?: BillableFeature[]
  • Optional billingCountryCode?: string
  • Optional billingId?: string
  • Optional billingInformation?: Omit<SubscriptionBillingInfo, "taxPercentage">
  • Optional billingPeriod?: BillingPeriod
  • Optional metadata?: Metadata | null
  • Optional payingCustomerId?: string
  • Optional paymentMethodId?: string
  • planId: string
  • Optional promotionCode?: string
  • Optional resourceId?: string
  • Optional scheduleStrategy?: ScheduleStrategy
  • Optional skipTrial?: boolean
  • Optional startDate?: Date
  • Optional unitQuantity?: number

ApplySubscriptionFragment

ApplySubscriptionFragment: { __typename?: "ApplySubscription"; entitlements?: ({ __typename?: "Entitlement" } & EntitlementFragment)[] | null; subscription?: ({ __typename?: "CustomerSubscription" } & SubscriptionFragment) | null }

Type declaration

  • Optional __typename?: "ApplySubscription"
  • Optional entitlements?: ({ __typename?: "Entitlement" } & EntitlementFragment)[] | null
  • Optional subscription?: ({ __typename?: "CustomerSubscription" } & SubscriptionFragment) | null

ApplySubscriptionInput

ApplySubscriptionInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; addons?: InputMaybe<SubscriptionAddonInput[]>; appliedCoupon?: InputMaybe<SubscriptionCouponInput>; awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; billingCountryCode?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<SubscriptionBillingInfo>; billingPeriod?: InputMaybe<BillingPeriod>; budget?: InputMaybe<BudgetConfigurationInput>; charges?: InputMaybe<ChargeInput[]>; customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>; payingCustomerId?: InputMaybe<Scalars["String"]>; paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>; paymentMethodId?: InputMaybe<Scalars["String"]>; planId: Scalars["String"]; priceOverrides?: InputMaybe<PriceOverrideInput[]>; promotionCode?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; scheduleStrategy?: InputMaybe<ScheduleStrategy>; skipTrial?: InputMaybe<Scalars["Boolean"]>; startDate?: InputMaybe<Scalars["DateTime"]>; subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>; trialOverrideConfiguration?: InputMaybe<TrialOverrideConfigurationInput>; unitQuantity?: InputMaybe<Scalars["Float"]> }

Apply subscription changes input

Type declaration

ApplySubscriptionMutation

ApplySubscriptionMutation: { __typename?: "Mutation"; applySubscription: { __typename?: "ApplySubscription" } & ApplySubscriptionFragment }

Type declaration

ApplySubscriptionMutationVariables

ApplySubscriptionMutationVariables: Exact<{ input: ApplySubscriptionInput }>

ApplySubscriptionResults

ApplySubscriptionResults: { subscription?: Subscription }

Type declaration

ArchiveCouponInput

ArchiveCouponInput: { environmentId?: InputMaybe<Scalars["UUID"]>; refId: Scalars["String"] }

Archive a coupon input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • refId: Scalars["String"]

    The unique identifier for the entity

ArchiveCustomerInput

ArchiveCustomerInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]> }

Type declaration

  • customerId: Scalars["String"]

    Customer slug

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

ArchiveCustomerMutation

ArchiveCustomerMutation: { __typename?: "Mutation"; archiveCustomer: { __typename?: "Customer"; customerId: string } }

Type declaration

  • Optional __typename?: "Mutation"
  • archiveCustomer: { __typename?: "Customer"; customerId: string }
    • Optional __typename?: "Customer"
    • customerId: string

ArchiveCustomerMutationVariables

ArchiveCustomerMutationVariables: Exact<{ input: ArchiveCustomerInput }>

ArchiveEnvironmentInput

ArchiveEnvironmentInput: { id?: InputMaybe<Scalars["String"]>; slug?: InputMaybe<Scalars["String"]> }

Input for archiving an environment

Type declaration

ArchiveFeatureGroupInput

ArchiveFeatureGroupInput: { environmentId: Scalars["UUID"]; featureGroupId: Scalars["String"] }

Input for archiving a feature group

Type declaration

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • featureGroupId: Scalars["String"]

    The feature group id

ArchiveFeatureInput

ArchiveFeatureInput: { environmentId?: InputMaybe<Scalars["UUID"]>; id: Scalars["String"] }

Input for archiving a feature

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • id: Scalars["String"]

    Unique identifier for the entity

ArchivePackageGroup

ArchivePackageGroup: { environmentId: Scalars["String"]; packageGroupId: Scalars["String"] }

The input type for archiving a package group

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • packageGroupId: Scalars["String"]

    The id of the package group

ArchivePlanInput

ArchivePlanInput: { environmentId?: InputMaybe<Scalars["UUID"]>; id?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]> }

Input for archiving a plan

Type declaration

ArchiveProductInput

ArchiveProductInput: { environmentId?: InputMaybe<Scalars["UUID"]>; refId: Scalars["String"] }

Input for archiving a product

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    Environment ID to archive the product in

  • refId: Scalars["String"]

    Product refId to archive

AttachCustomerPaymentMethodInput

AttachCustomerPaymentMethodInput: { billingCurrency?: InputMaybe<Currency>; customerId?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; integrationId?: InputMaybe<Scalars["String"]>; paymentMethodId: Scalars["String"]; refId?: InputMaybe<Scalars["String"]>; vendorIdentifier: VendorIdentifier }

Input for attaching a payment method to a customer

Type declaration

  • Optional billingCurrency?: InputMaybe<Currency>

    The currency to use for this payment method (only used for Zuora)

  • Optional customerId?: InputMaybe<Scalars["String"]>

    Customer slug

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional integrationId?: InputMaybe<Scalars["String"]>

    The billing integration to use for this payment method

  • paymentMethodId: Scalars["String"]

    Billing provider payment method id

  • Optional refId?: InputMaybe<Scalars["String"]>

    Customer slug

  • vendorIdentifier: VendorIdentifier

    The integration type to attach the payment method to

Auth0CredentialsInput

Auth0CredentialsInput: { applicationId: Scalars["String"]; applicationName: Scalars["String"]; applicationType: Auth0ApplicationType; clientDomain: Scalars["String"]; clientId: Scalars["String"]; clientSecret: Scalars["String"]; individualInitialPlanId?: InputMaybe<Scalars["String"]>; individualSubscriptionStartSetup?: InputMaybe<SubscriptionStartSetup>; organizationInitialPlanId?: InputMaybe<Scalars["String"]>; organizationSubscriptionStartSetup?: InputMaybe<SubscriptionStartSetup> }

Input configuration for Auth0 integration

Type declaration

  • applicationId: Scalars["String"]

    ID of the Auth0 application

  • applicationName: Scalars["String"]

    Name of the Auth0 application

  • applicationType: Auth0ApplicationType

    Type of the Auth0 application

  • clientDomain: Scalars["String"]

    Domain of the Auth0 client

  • clientId: Scalars["String"]

    ID of the Auth0 client

  • clientSecret: Scalars["String"]

    Secret of the Auth0 client

  • Optional individualInitialPlanId?: InputMaybe<Scalars["String"]>

    Initial plan ID for individual subscriptions

  • Optional individualSubscriptionStartSetup?: InputMaybe<SubscriptionStartSetup>

    Setup for starting individual subscriptions

  • Optional organizationInitialPlanId?: InputMaybe<Scalars["String"]>

    Initial plan ID for organization subscriptions

  • Optional organizationSubscriptionStartSetup?: InputMaybe<SubscriptionStartSetup>

    Setup for starting organization subscriptions

AutoCancellationRuleInput

AutoCancellationRuleInput: { sourcePlanId: Scalars["String"]; targetPlanId: Scalars["String"] }

Input for auto cancellation rule

Type declaration

  • sourcePlanId: Scalars["String"]

    ID of the source plan

  • targetPlanId: Scalars["String"]

    ID of the target plan

AutoRechargeSettingsFragment

AutoRechargeSettingsFragment: { __typename?: "AutoRechargeSettingsDTO"; createdAt?: any | null; currencyId: string; currentMonthlySpend: number; customerId: string; grantExpirationPeriod: GrantExpirationPeriod; isEnabled: boolean; maxSpendLimit?: number | null; targetBalance: number; thresholdType: ThresholdType; thresholdValue: number; updatedAt?: any | null }

Type declaration

  • Optional __typename?: "AutoRechargeSettingsDTO"
  • Optional createdAt?: any | null
  • currencyId: string
  • currentMonthlySpend: number
  • customerId: string
  • grantExpirationPeriod: GrantExpirationPeriod
  • isEnabled: boolean
  • Optional maxSpendLimit?: number | null
  • targetBalance: number
  • thresholdType: ThresholdType
  • thresholdValue: number
  • Optional updatedAt?: any | null

AutomaticRechargeConfiguration

AutomaticRechargeConfiguration: AutoRechargeSettingsFragment

AwsMarketplaceCredentialsInput

AwsMarketplaceCredentialsInput: { awsRoleArn: Scalars["String"] }

AWS Marketplace integration configuration for SaaS contract pricing model

Type declaration

  • awsRoleArn: Scalars["String"]

    AWS IAM role ARN with StiggAWSMarketplaceAccess policy attached

BaseEntitlement

BaseEntitlement: { accessDeniedReason?: AccessDeniedReason; feature?: EntitlementFeature; hasAccess: boolean; isFallback: boolean }

Type declaration

BasePlan

BasePlan: { displayName: string; id: string }

Type declaration

  • displayName: string
  • id: string

BigQueryCredentialsInput

BigQueryCredentialsInput: { credentialsJson: Scalars["String"]; datasetId: Scalars["String"]; datasetLocation: Scalars["String"]; gcsBucketName: Scalars["String"]; gcsBucketPath: Scalars["String"]; hmacKeyAccessId: Scalars["String"]; hmacKeySecret: Scalars["String"]; projectId: Scalars["String"] }

Input configuration for Google BigQuery integration

Type declaration

  • credentialsJson: Scalars["String"]

    JSON credentials for Google BigQuery

  • datasetId: Scalars["String"]

    ID of the BigQuery dataset

  • datasetLocation: Scalars["String"]

    Location of the BigQuery dataset

  • gcsBucketName: Scalars["String"]

    Name of the Google Cloud Storage bucket

  • gcsBucketPath: Scalars["String"]

    Path within the Google Cloud Storage bucket

  • hmacKeyAccessId: Scalars["String"]

    Access ID for the HMAC key

  • hmacKeySecret: Scalars["String"]

    Secret for the HMAC key

  • projectId: Scalars["String"]

    ID of the Google Cloud project

BillableFeature

BillableFeature: { featureId: string; quantity: number }

Type declaration

  • featureId: string
  • quantity: number

BillableFeatureInput

BillableFeatureInput: { featureId: Scalars["String"]; quantity: Scalars["Float"] }

Type declaration

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

BillingCadenceFilterComparison

BillingCadenceFilterComparison: { eq?: InputMaybe<BillingCadence>; gt?: InputMaybe<BillingCadence>; gte?: InputMaybe<BillingCadence>; iLike?: InputMaybe<BillingCadence>; in?: InputMaybe<BillingCadence[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<BillingCadence>; lt?: InputMaybe<BillingCadence>; lte?: InputMaybe<BillingCadence>; neq?: InputMaybe<BillingCadence>; notILike?: InputMaybe<BillingCadence>; notIn?: InputMaybe<BillingCadence[]>; notLike?: InputMaybe<BillingCadence> }

Type declaration

BillingModelFilterComparison

BillingModelFilterComparison: { eq?: InputMaybe<BillingModel>; gt?: InputMaybe<BillingModel>; gte?: InputMaybe<BillingModel>; iLike?: InputMaybe<BillingModel>; in?: InputMaybe<BillingModel[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<BillingModel>; lt?: InputMaybe<BillingModel>; lte?: InputMaybe<BillingModel>; neq?: InputMaybe<BillingModel>; notILike?: InputMaybe<BillingModel>; notIn?: InputMaybe<BillingModel[]>; notLike?: InputMaybe<BillingModel> }

Type declaration

BillingPeriodFilterComparison

BillingPeriodFilterComparison: { eq?: InputMaybe<BillingPeriod>; gt?: InputMaybe<BillingPeriod>; gte?: InputMaybe<BillingPeriod>; iLike?: InputMaybe<BillingPeriod>; in?: InputMaybe<BillingPeriod[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<BillingPeriod>; lt?: InputMaybe<BillingPeriod>; lte?: InputMaybe<BillingPeriod>; neq?: InputMaybe<BillingPeriod>; notILike?: InputMaybe<BillingPeriod>; notIn?: InputMaybe<BillingPeriod[]>; notLike?: InputMaybe<BillingPeriod> }

Type declaration

BillingProductsInput

BillingProductsInput: { integrationId?: InputMaybe<Scalars["String"]>; nextPage?: InputMaybe<Scalars["String"]>; productNameOrId?: InputMaybe<Scalars["String"]> }

Input parameters for getting Billing integration products

Type declaration

  • Optional integrationId?: InputMaybe<Scalars["String"]>

    ID of the Billing integration to fetch products from

  • Optional nextPage?: InputMaybe<Scalars["String"]>

    Token for retrieving the next page of results

  • Optional productNameOrId?: InputMaybe<Scalars["String"]>

    Name or ID of the product to search for

BooleanEntitlementFallback

BooleanEntitlementFallback: { hasAccess: boolean }

Type declaration

  • hasAccess: boolean

BooleanEntitlementOptions

BooleanEntitlementOptions: { fallback?: BooleanEntitlementFallback; shouldTrack?: boolean }

Type declaration

BooleanFieldComparison

BooleanFieldComparison: { is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]> }

Type declaration

BudgetConfigurationInput

BudgetConfigurationInput: { hasSoftLimit: Scalars["Boolean"]; limit: Scalars["Float"] }

Budget configuration input

Type declaration

  • hasSoftLimit: Scalars["Boolean"]

    Indicates the behavior of the budget when the limit is exceeded. If true, the limit is a soft limit, if false, the limit is a hard limit. Default is false.

  • limit: Scalars["Float"]

    The maximum spending limit

CancelSubscriptionMutation

CancelSubscriptionMutation: { __typename?: "Mutation"; cancelSubscription: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment }

Type declaration

CancelSubscriptionMutationVariables

CancelSubscriptionMutationVariables: Exact<{ input: SubscriptionCancellationInput }>

CancelSubscriptionUpdatesMutation

CancelSubscriptionUpdatesMutation: { __typename?: "Mutation"; cancelSchedule: string }

Type declaration

  • Optional __typename?: "Mutation"
  • cancelSchedule: string

CancelSubscriptionUpdatesMutationVariables

CancelSubscriptionUpdatesMutationVariables: Exact<{ input: SubscriptionUpdateScheduleCancellationInput }>

ChargeInput

ChargeInput: { id: Scalars["String"]; quantity: Scalars["Float"]; type: ChargeType }

Type declaration

ChargeSubscriptionUsageInput

ChargeSubscriptionUsageInput: { environmentId?: InputMaybe<Scalars["UUID"]>; subscriptionId: Scalars["String"]; untilDate?: InputMaybe<Scalars["DateTime"]> }

Input for triggering an immediate usage charge for a subscription

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The id of the subscriptions environment

  • subscriptionId: Scalars["String"]

    The subscription reference id to charge usage for

  • Optional untilDate?: InputMaybe<Scalars["DateTime"]>

    The end date until which to calculate the usage

CheckoutAddon

CheckoutAddon: { addonId: string; quantity?: number }

Type declaration

  • addonId: string
  • Optional quantity?: number

CheckoutBillingIntegration

CheckoutBillingIntegration: { billingCredentials: StripeCheckoutCredentialsFragment | ZuoraCheckoutCredentialsFragment; billingIdentifier: BillingVendorIdentifier; credentials: { accountId?: string | null; publicKey?: string | null } }

Type declaration

CheckoutConfiguration

CheckoutConfiguration: Omit<CheckoutConfigurationFragment, "__typename">

CheckoutConfigurationFragment

CheckoutConfigurationFragment: { __typename: "CheckoutConfiguration"; content?: { __typename?: "CheckoutContent"; collectPhoneNumber?: boolean | null } | null; customCss?: string | null; palette?: { __typename: "CheckoutColorPalette"; backgroundColor?: string | null; borderColor?: string | null; primary?: string | null; summaryBackgroundColor?: string | null; textColor?: string | null } | null; typography?: ({ __typename: "TypographyConfiguration" } & TypographyConfigurationFragment) | null }

Type declaration

  • __typename: "CheckoutConfiguration"
  • Optional content?: { __typename?: "CheckoutContent"; collectPhoneNumber?: boolean | null } | null
  • Optional customCss?: string | null
  • Optional palette?: { __typename: "CheckoutColorPalette"; backgroundColor?: string | null; borderColor?: string | null; primary?: string | null; summaryBackgroundColor?: string | null; textColor?: string | null } | null
  • Optional typography?: ({ __typename: "TypographyConfiguration" } & TypographyConfigurationFragment) | null

CheckoutConfigurationInput

CheckoutConfigurationInput: { content?: InputMaybe<CheckoutContentInput>; customCss?: InputMaybe<Scalars["String"]>; palette?: InputMaybe<CheckoutPaletteInput>; typography?: InputMaybe<TypographyConfigurationInput> }

Input for setting up the checkout widget’s design.

Type declaration

CheckoutContentInput

CheckoutContentInput: { collectPhoneNumber?: InputMaybe<Scalars["Boolean"]> }

Input for content customization in the checkout process.

Type declaration

  • Optional collectPhoneNumber?: InputMaybe<Scalars["Boolean"]>

    Indicates whether the checkout form should ask for a phone number.

CheckoutOptions

CheckoutOptions: { allowPromoCodes?: InputMaybe<Scalars["Boolean"]>; allowTaxIdCollection?: InputMaybe<Scalars["Boolean"]>; cancelUrl: Scalars["String"]; collectBillingAddress?: InputMaybe<Scalars["Boolean"]>; collectPhoneNumber?: InputMaybe<Scalars["Boolean"]>; referenceId?: InputMaybe<Scalars["String"]>; successUrl: Scalars["String"] }

Type declaration

CheckoutPaletteInput

CheckoutPaletteInput: { backgroundColor?: InputMaybe<Scalars["String"]>; borderColor?: InputMaybe<Scalars["String"]>; primary?: InputMaybe<Scalars["String"]>; summaryBackgroundColor?: InputMaybe<Scalars["String"]>; textColor?: InputMaybe<Scalars["String"]> }

Input for customizing checkout color scheme.

Type declaration

  • Optional backgroundColor?: InputMaybe<Scalars["String"]>

    Background color of the widget.

  • Optional borderColor?: InputMaybe<Scalars["String"]>

    Color applied to widget borders or separators.

  • Optional primary?: InputMaybe<Scalars["String"]>

    Primary accent color used throughout the widget.

  • Optional summaryBackgroundColor?: InputMaybe<Scalars["String"]>

    Background color for the order summary section during checkout.

  • Optional textColor?: InputMaybe<Scalars["String"]>

    Default color used for text content.

CheckoutStateFragment

CheckoutStateFragment: { __typename?: "CheckoutState"; activeSubscription?: ({ __typename?: "CustomerSubscription" } & SubscriptionFragment) | null; billingIntegration: { __typename?: "CheckoutBillingIntegration"; billingCredentials: ({ __typename?: "StripeCheckoutCredentials" } & StripeCheckoutCredentialsFragment) | ({ __typename?: "ZuoraCheckoutCredentials" } & ZuoraCheckoutCredentialsFragment); billingIdentifier: BillingVendorIdentifier; credentials: { __typename?: "CheckoutCredentials"; accountId?: string | null; publicKey?: string | null } }; configuration?: ({ __typename?: "CheckoutConfiguration" } & CheckoutConfigurationFragment) | null; customer: { __typename?: "Customer" } & CustomerFragment; plan: { __typename?: "Plan" } & PlanFragment; resource?: ({ __typename?: "CustomerResource" } & CustomerResourceFragment) | null; setupSecret: string }

Type declaration

CheckoutStateInput

CheckoutStateInput: { billingCountryCode?: InputMaybe<Scalars["String"]>; customerId: Scalars["String"]; planId: Scalars["String"]; productId?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]> }

Checkout state input

Type declaration

  • Optional billingCountryCode?: InputMaybe<Scalars["String"]>

    The billing country code of the customer to checkout

  • customerId: Scalars["String"]

    Customer ID

  • planId: Scalars["String"]

    The plan ID to checkout

  • Optional productId?: InputMaybe<Scalars["String"]>

    The Plan Product ID to checkout

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The resource ID to checkout

CheckoutStatePlan

CheckoutStatePlan: Plan & Pick<PlanFragment, "prices">

ClearCustomerPersistentCacheInput

ClearCustomerPersistentCacheInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; resourceId?: InputMaybe<Scalars["String"]> }

Input for clearing a customers persistent cache.

Type declaration

  • customerId: Scalars["String"]

    The unique identifier of the customer whose cache should be cleared.

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The resource ID scoped to the customer.

ClientConfiguration

ClientConfiguration: { apiKey: string; baseEdgeUri?: string; baseUri?: string; cacheTtlMs?: number; clientName?: string; clientVersion?: string; customerId?: string | null; customerToken?: string | null; enableEdge?: boolean; entitlementPollingInterval?: number; entitlementsFallback?: EntitlementsFallback; lazyLoad?: boolean; logConfiguration?: LogConfiguration; offline?: boolean; resourceId?: string | null; useEntitlementPolling?: boolean }

Type declaration

  • apiKey: string
  • Optional baseEdgeUri?: string
  • Optional baseUri?: string
  • Optional cacheTtlMs?: number
  • Optional clientName?: string
  • Optional clientVersion?: string
  • Optional customerId?: string | null
  • Optional customerToken?: string | null
  • Optional enableEdge?: boolean
  • Optional entitlementPollingInterval?: number
    deprecated

    not longer in use

  • Optional entitlementsFallback?: EntitlementsFallback
  • Optional lazyLoad?: boolean
  • Optional logConfiguration?: LogConfiguration
  • Optional offline?: boolean
  • Optional resourceId?: string | null
  • Optional useEntitlementPolling?: boolean
    deprecated

    not longer in use

CompatiblePackageGroup

CompatiblePackageGroup: { addons: Addon[]; displayName: string; options?: CompatiblePackageGroupOptions; packageGroupId: string }

Type declaration

CompatiblePackageGroupOptions

CompatiblePackageGroupOptions: { freeItems?: number; minItems?: number }

Type declaration

  • Optional freeItems?: number
  • Optional minItems?: number

Coupon

Coupon: { amountsOff?: Money[] | null; description?: string | null; discountValue: number; id: string; metadata?: Metadata | null; name: string; percentOff?: number | null }

Type declaration

  • Optional amountsOff?: Money[] | null
  • Optional description?: string | null
  • discountValue: number
  • id: string
  • Optional metadata?: Metadata | null
  • name: string
  • Optional percentOff?: number | null

CouponFilter

CouponFilter: { and?: InputMaybe<CouponFilter[]>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; customers?: InputMaybe<CouponFilterCustomerFilter>; description?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<CouponFilter[]>; refId?: InputMaybe<StringFieldComparison>; source?: InputMaybe<CouponSourceFilterComparison>; status?: InputMaybe<CouponStatusFilterComparison>; type?: InputMaybe<CouponTypeFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

CouponFilterCustomerFilter

CouponFilterCustomerFilter: { and?: InputMaybe<CouponFilterCustomerFilter[]>; awsMarketplaceCustomerId?: InputMaybe<StringFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmHubspotCompanyId?: InputMaybe<StringFieldComparison>; crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; customerId?: InputMaybe<StringFieldComparison>; deletedAt?: InputMaybe<DateFieldComparison>; email?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<CouponFilterCustomerFilter[]>; refId?: InputMaybe<StringFieldComparison>; salesforceId?: InputMaybe<StringFieldComparison>; searchQuery?: InputMaybe<CustomerSearchQueryFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

CouponFragment

CouponFragment: { __typename?: "Coupon"; additionalMetaData?: any | null; amountsOff?: { __typename?: "Money"; amount: number; currency: Currency }[] | null; billingId?: string | null; billingLinkUrl?: string | null; createdAt: any; description?: string | null; discountValue: number; id: any; name: string; percentOff?: number | null; refId: string; status: CouponStatus; syncStates?: { __typename?: "SyncState"; status: SyncStatus; vendorIdentifier: VendorIdentifier }[] | null; type: CouponType; updatedAt: any }

Type declaration

  • Optional __typename?: "Coupon"
  • Optional additionalMetaData?: any | null
  • Optional amountsOff?: { __typename?: "Money"; amount: number; currency: Currency }[] | null
  • Optional billingId?: string | null
  • Optional billingLinkUrl?: string | null
  • createdAt: any
  • Optional description?: string | null
  • discountValue: number
  • id: any
  • name: string
  • Optional percentOff?: number | null
  • refId: string
  • status: CouponStatus
  • Optional syncStates?: { __typename?: "SyncState"; status: SyncStatus; vendorIdentifier: VendorIdentifier }[] | null
  • type: CouponType
  • updatedAt: any

CouponSort

CouponSort: { direction: SortDirection; field: CouponSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

CouponSourceFilterComparison

CouponSourceFilterComparison: { eq?: InputMaybe<CouponSource>; in?: InputMaybe<CouponSource[]> }

Type declaration

CouponStatusFilterComparison

CouponStatusFilterComparison: { eq?: InputMaybe<CouponStatus>; gt?: InputMaybe<CouponStatus>; gte?: InputMaybe<CouponStatus>; iLike?: InputMaybe<CouponStatus>; in?: InputMaybe<CouponStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<CouponStatus>; lt?: InputMaybe<CouponStatus>; lte?: InputMaybe<CouponStatus>; neq?: InputMaybe<CouponStatus>; notILike?: InputMaybe<CouponStatus>; notIn?: InputMaybe<CouponStatus[]>; notLike?: InputMaybe<CouponStatus> }

Type declaration

CouponTypeFilterComparison

CouponTypeFilterComparison: { eq?: InputMaybe<CouponType>; gt?: InputMaybe<CouponType>; gte?: InputMaybe<CouponType>; iLike?: InputMaybe<CouponType>; in?: InputMaybe<CouponType[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<CouponType>; lt?: InputMaybe<CouponType>; lte?: InputMaybe<CouponType>; neq?: InputMaybe<CouponType>; notILike?: InputMaybe<CouponType>; notIn?: InputMaybe<CouponType[]>; notLike?: InputMaybe<CouponType> }

Type declaration

CreateCouponInput

CreateCouponInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; amountsOff?: InputMaybe<MoneyInputDto[]>; description?: InputMaybe<Scalars["String"]>; discountValue?: InputMaybe<Scalars["Float"]>; durationInMonths?: InputMaybe<Scalars["Float"]>; environmentId?: InputMaybe<Scalars["UUID"]>; name: Scalars["String"]; percentOff?: InputMaybe<Scalars["Float"]>; refId: Scalars["String"]; type?: InputMaybe<CouponType> }

Create a new coupon input

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Metadata associated with the entity

  • Optional amountsOff?: InputMaybe<MoneyInputDto[]>

    Fixed amount discounts in different currencies

  • Optional description?: InputMaybe<Scalars["String"]>

    Description of the coupon

  • Optional discountValue?: InputMaybe<Scalars["Float"]>

    Discount value of the coupon (deprecated)

  • Optional durationInMonths?: InputMaybe<Scalars["Float"]>

    Duration of the coupon validity in months

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • name: Scalars["String"]

    Name of the coupon

  • Optional percentOff?: InputMaybe<Scalars["Float"]>

    Percentage discount off the original price

  • refId: Scalars["String"]

    The unique identifier for the entity

  • Optional type?: InputMaybe<CouponType>

    Type of the coupon (percentage or fixed amount)

CreateCouponMutation

CreateCouponMutation: { __typename?: "Mutation"; createOneCoupon: { __typename?: "Coupon" } & CouponFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • createOneCoupon: { __typename?: "Coupon" } & CouponFragment

CreateCouponMutationVariables

CreateCouponMutationVariables: Exact<{ input: CreateCouponInput }>

CreateEnvironment

CreateEnvironment: { color?: InputMaybe<Scalars["String"]>; createdAt?: InputMaybe<Scalars["DateTime"]>; description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; hardenClientAccessEnabled?: InputMaybe<Scalars["Boolean"]>; id?: InputMaybe<Scalars["String"]>; provisionStatus?: InputMaybe<EnvironmentProvisionStatus>; slug?: InputMaybe<Scalars["String"]>; type?: InputMaybe<EnvironmentType> }

Input for creating a new environment

Type declaration

  • Optional color?: InputMaybe<Scalars["String"]>

    The color used to distinguish this environment in the UI

  • Optional createdAt?: InputMaybe<Scalars["DateTime"]>

    The timestamp when the environment was created

  • Optional description?: InputMaybe<Scalars["String"]>

    Optional description of the environment

  • Optional displayName?: InputMaybe<Scalars["String"]>

    The name of the environment that will be displayed in the UI

  • Optional hardenClientAccessEnabled?: InputMaybe<Scalars["Boolean"]>

    Whether client-side security hardening is enabled for this environment

  • Optional id?: InputMaybe<Scalars["String"]>

    Unique identifier for the entity

  • Optional provisionStatus?: InputMaybe<EnvironmentProvisionStatus>

    The current provisioning status of the environment

  • Optional slug?: InputMaybe<Scalars["String"]>

    A unique identifier for the environment

  • Optional type?: InputMaybe<EnvironmentType>

    The type of environment (production or non-production)

CreateEnvironmentOptions

CreateEnvironmentOptions: { createDefaultProduct?: InputMaybe<Scalars["Boolean"]> }

Additional options for environment creation

Type declaration

  • Optional createDefaultProduct?: InputMaybe<Scalars["Boolean"]>

    Whether to automatically create a default product in the new environment

CreateExperimentInput

CreateExperimentInput: { controlGroupName: Scalars["String"]; description?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; name: Scalars["String"]; productId: Scalars["String"]; productSettings?: InputMaybe<ProductSettingsInput>; variantGroupName: Scalars["String"]; variantPercentage: Scalars["Float"] }

Input parameters for creating a new experiment

Type declaration

  • controlGroupName: Scalars["String"]

    Name for the control group

  • Optional description?: InputMaybe<Scalars["String"]>

    Description of the experiements

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • name: Scalars["String"]

    Name of the experiment

  • productId: Scalars["String"]

    Internal identifier for the product experiment is associated with

  • Optional productSettings?: InputMaybe<ProductSettingsInput>

    Product settings for the variant group

  • variantGroupName: Scalars["String"]

    Name for the variant group

  • variantPercentage: Scalars["Float"]

    Percentage of users in the variant group

CreateFeatureGroupInput

CreateFeatureGroupInput: { description?: InputMaybe<Scalars["String"]>; displayName: Scalars["String"]; environmentId: Scalars["UUID"]; featureGroupId: Scalars["String"]; features: Scalars["String"][] }

Input for creating a feature group

Type declaration

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the feature group

  • displayName: Scalars["String"]

    The display name of the feature group

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • featureGroupId: Scalars["String"]

    The feature group id

  • features: Scalars["String"][]

    The features in the feature group

CreateHook

CreateHook: { configuration?: InputMaybe<Scalars["JSON"]>; createdAt?: InputMaybe<Scalars["DateTime"]>; description?: InputMaybe<Scalars["String"]>; endpoint?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; eventLogTypes?: InputMaybe<EventLogType[]>; id?: InputMaybe<Scalars["UUID"]>; secretKey?: InputMaybe<Scalars["String"]>; status?: InputMaybe<HookStatus> }

Type declaration

CreateIntegrationInput

CreateIntegrationInput: { appStoreCredentials?: InputMaybe<AppStoreCredentialsInput>; auth0Credentials?: InputMaybe<Auth0CredentialsInput>; awsMarketplaceCredentials?: InputMaybe<AwsMarketplaceCredentialsInput>; bigQueryCredentials?: InputMaybe<BigQueryCredentialsInput>; environmentId: Scalars["String"]; hubspotCredentials?: InputMaybe<HubspotCredentialsInput>; integrationId?: InputMaybe<Scalars["String"]>; isDefault?: InputMaybe<Scalars["Boolean"]>; openFGACredentials?: InputMaybe<OpenFgaCredentialsInput>; salesforceCredentials?: InputMaybe<SalesforceCredentialsInput>; snowflakeCredentials?: InputMaybe<SnowflakeCredentialsInput>; stripeCredentials?: InputMaybe<StripeCredentialsInput>; vendorIdentifier: VendorIdentifier; zuoraCredentials?: InputMaybe<ZuoraCredentialsInput> }

Create integration input

Type declaration

CreateManyPackageEntitlementsInput

CreateManyPackageEntitlementsInput: { packageEntitlements: PackageEntitlementInput[] }

Type declaration

CreateManyPromotionalEntitlementsInput

CreateManyPromotionalEntitlementsInput: { promotionalEntitlements: PromotionalEntitlementInput[] }

Type declaration

CreateMeter

CreateMeter: { aggregation: MeterAggregation; filters: MeterFilterDefinitionInput[] }

A meter configuration that tracks and measures usage-based functionality

Type declaration

CreateOfferDraftInput

CreateOfferDraftInput: { environmentId: Scalars["UUID"]; offerId: Scalars["String"] }

Create offer draft input - creates new version inheriting all fields from existing offer

Type declaration

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • offerId: Scalars["String"]

    The unique identifier for the entity

CreateOfferInput

CreateOfferInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; description?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; name: Scalars["String"]; offerId: Scalars["String"] }

Create offer input - only creates first version of new offers

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Metadata associated with the entity

  • Optional description?: InputMaybe<Scalars["String"]>

    Offer description

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • name: Scalars["String"]

    Offer name

  • offerId: Scalars["String"]

    The unique identifier for the entity

CreateOneEnvironmentInput

CreateOneEnvironmentInput: { environment: CreateEnvironment; options?: InputMaybe<CreateEnvironmentOptions> }

Input for creating a single environment

Type declaration

CreateOneHookInput

CreateOneHookInput: { hook: CreateHook }

Type declaration

CreateOneIntegrationInput

CreateOneIntegrationInput: { integration: CreateIntegrationInput }

Type declaration

CreateOneProductInput

CreateOneProductInput: { product: ProductCreateInput }

Input for creating a single product

Type declaration

CreateOrUpdateAwsMarketplaceProductInput

CreateOrUpdateAwsMarketplaceProductInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; autoCancellationRules?: InputMaybe<AutoCancellationRuleInput[]>; awsDimensionsMapping: DimensionsMappingInput[]; awsProductId?: InputMaybe<Scalars["String"]>; description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; multipleSubscriptions?: InputMaybe<Scalars["Boolean"]>; productId?: InputMaybe<Scalars["String"]>; productSettings?: InputMaybe<ProductSettingsInput>; refId?: InputMaybe<Scalars["String"]>; usageResetCutoffRule?: InputMaybe<SubscriptionUpdateUsageResetCutoffRuleInput> }

Create or update AWS Marketplace product input

Type declaration

CreatePackageEntitlementInput

CreatePackageEntitlementInput: { credit?: InputMaybe<PackageCreditEntitlementInput>; feature?: InputMaybe<PackageFeatureEntitlementInput> }

Package entitlement input

Type declaration

CreatePackageEntitlementsInput

CreatePackageEntitlementsInput: { entitlements: CreatePackageEntitlementInput[]; environmentId?: InputMaybe<Scalars["UUID"]>; packageId: Scalars["UUID"] }

Create package entitlements input

Type declaration

CreatePackageGroup

CreatePackageGroup: { description?: InputMaybe<Scalars["String"]>; displayName: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; packageGroupId: Scalars["String"]; productId: Scalars["String"] }

The input type for creating a package group

Type declaration

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the package group

  • displayName: Scalars["String"]

    The display name of the package group

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • packageGroupId: Scalars["String"]

    The id of the package group

  • productId: Scalars["String"]

    The id of the related product

CreatePaymentSessionInput

CreatePaymentSessionInput: Omit<PaymentSessionInput, "customerId">

CreatePaymentSessionMutation

CreatePaymentSessionMutation: { __typename?: "Mutation"; createPaymentSession: { __typename?: "PaymentSession" } & PaymentSessionFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • createPaymentSession: { __typename?: "PaymentSession" } & PaymentSessionFragment

CreatePaymentSessionMutationVariables

CreatePaymentSessionMutationVariables: Exact<{ input: PaymentSessionInput }>

CreateSubscriptionMutation

CreateSubscriptionMutation: { __typename?: "Mutation"; createSubscription: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment }

Type declaration

CreateSubscriptionMutationVariables

CreateSubscriptionMutationVariables: Exact<{ input: SubscriptionInput }>

CreateWorkflowTriggerInput

CreateWorkflowTriggerInput: { configuration?: InputMaybe<Scalars["JSON"]>; endpoint: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; eventLogTypes: EventLogType[]; triggerId?: InputMaybe<Scalars["String"]> }

Create workflow trigger input

Type declaration

  • Optional configuration?: InputMaybe<Scalars["JSON"]>

    A JSON containing the configuration for each event log type

  • endpoint: Scalars["String"]

    Workflow trigger endpoint

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • eventLogTypes: EventLogType[]

    Event log types

  • Optional triggerId?: InputMaybe<Scalars["String"]>

    Workflow trigger id

CreditBalanceFragment

CreditBalanceFragment: { __typename?: "CreditBalance"; currency: { __typename?: "SlimCustomCurrency"; currencyId: string; displayName: string; symbol?: string | null; units?: { __typename?: "Units"; plural: string; singular: string } | null }; currentBalance: number; customerId: string; resourceId?: string | null; totalConsumed: number; totalGranted: number; validUntil?: number | null }

Type declaration

  • Optional __typename?: "CreditBalance"
  • currency: { __typename?: "SlimCustomCurrency"; currencyId: string; displayName: string; symbol?: string | null; units?: { __typename?: "Units"; plural: string; singular: string } | null }
    • Optional __typename?: "SlimCustomCurrency"
    • currencyId: string
    • displayName: string
    • Optional symbol?: string | null
    • Optional units?: { __typename?: "Units"; plural: string; singular: string } | null
  • currentBalance: number
  • customerId: string
  • Optional resourceId?: string | null
  • totalConsumed: number
  • totalGranted: number
  • Optional validUntil?: number | null

CreditBalanceSummaryInput

CreditBalanceSummaryInput: { currencyId?: InputMaybe<Scalars["String"]>; customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; resourceId?: InputMaybe<Scalars["String"]> }

Input for retrieving credit balance

Type declaration

  • Optional currencyId?: InputMaybe<Scalars["String"]>

    The custom currency ID of the credit grant

  • customerId: Scalars["String"]

    The customer ID of the credit grant

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The resource ID of the credit grant

CreditBalanceUpdatedPayloadFragment

CreditBalanceUpdatedPayloadFragment: { __typename?: "CreditBalanceUpdated"; currency: { __typename?: "SlimCustomCurrency"; currencyId: string; displayName: string; symbol?: string | null; units?: { __typename?: "Units"; plural: string; singular: string } | null }; currencyId: string; currentBalance: number; customerId: string; resourceId?: string | null; totalConsumed: number; totalGranted: number; validUntil?: number | null }

Type declaration

  • Optional __typename?: "CreditBalanceUpdated"
  • currency: { __typename?: "SlimCustomCurrency"; currencyId: string; displayName: string; symbol?: string | null; units?: { __typename?: "Units"; plural: string; singular: string } | null }
    • Optional __typename?: "SlimCustomCurrency"
    • currencyId: string
    • displayName: string
    • Optional symbol?: string | null
    • Optional units?: { __typename?: "Units"; plural: string; singular: string } | null
  • currencyId: string
  • currentBalance: number
  • customerId: string
  • Optional resourceId?: string | null
  • totalConsumed: number
  • totalGranted: number
  • Optional validUntil?: number | null

CreditGrantBillingInfoInput

CreditGrantBillingInfoInput: { taxPercentage?: InputMaybe<Scalars["Float"]>; taxRateIds?: InputMaybe<Scalars["String"][]> }

Credit grant billing information input

Type declaration

CreditGrantCouponInput

CreditGrantCouponInput: { billingCouponId?: InputMaybe<Scalars["String"]>; couponId?: InputMaybe<Scalars["String"]>; promotionCode?: InputMaybe<Scalars["String"]> }

Credit grant coupon input object

Type declaration

CreditGrantFragment

CreditGrantFragment: { __typename?: "CreditGrant"; additionalMetaData?: any | null; amount: number; automaticRechargeConfigurationId?: any | null; comment?: string | null; consumedAmount: number; cost: { __typename?: "Money"; amount: number; currency: Currency }; createdAt: any; currencyId: string; customerId: string; displayName: string; effectiveAt: any; expireAt?: any | null; grantId: string; grantType: CreditGrantType; invoiceId?: string | null; latestInvoice?: ({ __typename?: "CreditGrantInvoice" } & CreditGrantInvoiceFragment) | null; paymentCollection: PaymentCollection; priority: number; resourceId?: string | null; status: CreditGrantStatus; updatedAt: any }

Type declaration

  • Optional __typename?: "CreditGrant"
  • Optional additionalMetaData?: any | null
  • amount: number
  • Optional automaticRechargeConfigurationId?: any | null
  • Optional comment?: string | null
  • consumedAmount: number
  • cost: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • createdAt: any
  • currencyId: string
  • customerId: string
  • displayName: string
  • effectiveAt: any
  • Optional expireAt?: any | null
  • grantId: string
  • grantType: CreditGrantType
  • Optional invoiceId?: string | null
  • Optional latestInvoice?: ({ __typename?: "CreditGrantInvoice" } & CreditGrantInvoiceFragment) | null
  • paymentCollection: PaymentCollection
  • priority: number
  • Optional resourceId?: string | null
  • status: CreditGrantStatus
  • updatedAt: any

CreditGrantInput

CreditGrantInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; amount: Scalars["Float"]; awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>; comment?: InputMaybe<Scalars["String"]>; cost?: InputMaybe<MoneyInputDto>; currencyId: Scalars["String"]; customerId: Scalars["String"]; displayName: Scalars["String"]; effectiveAt?: InputMaybe<Scalars["DateTime"]>; environmentId?: InputMaybe<Scalars["UUID"]>; expireAt?: InputMaybe<Scalars["DateTime"]>; grantType: CreditGrantType; paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>; priority?: InputMaybe<Scalars["Float"]>; resourceId?: InputMaybe<Scalars["String"]> }

Input for creating a credit grant

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Metadata associated with the entity

  • amount: Scalars["Float"]

    The amount of the credit grant

  • Optional awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>

    Wait for payment confirmation before returning

  • Optional comment?: InputMaybe<Scalars["String"]>

    The comment for the credit grant

  • Optional cost?: InputMaybe<MoneyInputDto>

    The fiat cost of the credit grant

  • currencyId: Scalars["String"]

    The custom currency ID of the credit grant

  • customerId: Scalars["String"]

    The customer ID of the credit grant

  • displayName: Scalars["String"]

    The display name of the credit grant

  • Optional effectiveAt?: InputMaybe<Scalars["DateTime"]>

    The effective date of the credit grant

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional expireAt?: InputMaybe<Scalars["DateTime"]>

    The expiration date of the credit grant

  • grantType: CreditGrantType

    The type of the credit grant

  • Optional paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>

    The method used to collect payments for the credit grant

  • Optional priority?: InputMaybe<Scalars["Float"]>

    The priority of the credit grant

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The resource ID of the credit grant

CreditGrantInvoiceFragment

CreditGrantInvoiceFragment: { __typename?: "CreditGrantInvoice"; amountDue?: number | null; attemptCount?: number | null; billingId: string; billingReason?: CreditGrantInvoiceBillingReason | null; createdAt: any; currency?: string | null; dueDate?: any | null; errorMessage?: string | null; paymentSecret?: string | null; paymentUrl?: string | null; pdfUrl?: string | null; requiresAction: boolean; status: CreditGrantInvoiceStatus; subTotal?: number | null; subTotalExcludingTax?: number | null; tax?: number | null; total?: number | null; totalExcludingTax?: number | null; updatedAt: any }

Type declaration

  • Optional __typename?: "CreditGrantInvoice"
  • Optional amountDue?: number | null
  • Optional attemptCount?: number | null
  • billingId: string
  • Optional billingReason?: CreditGrantInvoiceBillingReason | null
  • createdAt: any
  • Optional currency?: string | null
  • Optional dueDate?: any | null
  • Optional errorMessage?: string | null
  • Optional paymentSecret?: string | null
  • Optional paymentUrl?: string | null
  • Optional pdfUrl?: string | null
  • requiresAction: boolean
  • status: CreditGrantInvoiceStatus
  • Optional subTotal?: number | null
  • Optional subTotalExcludingTax?: number | null
  • Optional tax?: number | null
  • Optional total?: number | null
  • Optional totalExcludingTax?: number | null
  • updatedAt: any

CreditLedgerFragment

CreditLedgerFragment: { __typename?: "CreditLedgerEvent"; amount: number; creditCurrencyId: string; creditGrantId: string; customerId: string; eventId?: string | null; eventType: CreditLedgerEventType; featureId?: string | null; resourceId?: string | null; timestamp: string }

Type declaration

  • Optional __typename?: "CreditLedgerEvent"
  • amount: number
  • creditCurrencyId: string
  • creditGrantId: string
  • customerId: string
  • Optional eventId?: string | null
  • eventType: CreditLedgerEventType
  • Optional featureId?: string | null
  • Optional resourceId?: string | null
  • timestamp: string

CreditLedgerInput

CreditLedgerInput: { currencyId?: InputMaybe<Scalars["String"]>; customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; paging?: InputMaybe<CursorPaging>; resourceId?: InputMaybe<Scalars["String"]> }

Input for retrieving credit ledger

Type declaration

  • Optional currencyId?: InputMaybe<Scalars["String"]>

    The credit currency ID of the credit ledger

  • customerId: Scalars["String"]

    The customer ID of the credit ledger

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The environment ID of the credit ledger

  • Optional paging?: InputMaybe<CursorPaging>

    Cursor-based pagination input

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The resource ID of the credit ledger

CreditRateInput

CreditRateInput: { amount: Scalars["Float"]; costFormula?: InputMaybe<Scalars["String"]>; currencyId: Scalars["String"]; customCurrencyId?: InputMaybe<Scalars["UUID"]> }

Credit Rate Input

Type declaration

  • amount: Scalars["Float"]

    The credit rate amount

  • Optional costFormula?: InputMaybe<Scalars["String"]>

    A custom formula for calculating cost based on single event dimensions

  • currencyId: Scalars["String"]

    The custom currency refId for the credit rate

  • Optional customCurrencyId?: InputMaybe<Scalars["UUID"]>

    The custom currency ID for the credit rate

CreditUsageFragment

CreditUsageFragment: { __typename?: "CreditUsage"; currency?: ({ __typename?: "SlimCustomCurrency" } & SlimCustomCurrencyFragment) | null; series: { __typename?: "CreditUsageSeries"; featureId: string; featureName: string; points: { __typename?: "CreditUsagePoint"; timestamp: any; value: number }[]; totalCredits: number }[] }

Type declaration

  • Optional __typename?: "CreditUsage"
  • Optional currency?: ({ __typename?: "SlimCustomCurrency" } & SlimCustomCurrencyFragment) | null
  • series: { __typename?: "CreditUsageSeries"; featureId: string; featureName: string; points: { __typename?: "CreditUsagePoint"; timestamp: any; value: number }[]; totalCredits: number }[]

CreditUsageInput

CreditUsageInput: { currencyId?: InputMaybe<Scalars["String"]>; customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; resourceId?: InputMaybe<Scalars["String"]>; timeRange?: InputMaybe<CreditUsageTimeRange> }

Input for retrieving credit usage

Type declaration

  • Optional currencyId?: InputMaybe<Scalars["String"]>

    The currency ID to filter credit usage by specific currency

  • customerId: Scalars["String"]

    The customer ID of the credit usage

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The environment ID of the credit usage

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The resource ID of the credit usage

  • Optional timeRange?: InputMaybe<CreditUsageTimeRange>

    The time range for the credit usage

CreditsBalanceSummaryFragment

CreditsBalanceSummaryFragment: { __typename?: "CreditBalanceSummary"; balances: ({ __typename?: "CreditBalance" } & CreditBalanceFragment)[]; customerId: string }

Type declaration

  • Optional __typename?: "CreditBalanceSummary"
  • balances: ({ __typename?: "CreditBalance" } & CreditBalanceFragment)[]
  • customerId: string

CursorPaging

CursorPaging: { after?: InputMaybe<Scalars["ConnectionCursor"]>; before?: InputMaybe<Scalars["ConnectionCursor"]>; first?: InputMaybe<Scalars["Int"]>; last?: InputMaybe<Scalars["Int"]> }

Type declaration

CustomCurrencyInput

CustomCurrencyInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; currencyId: Scalars["String"]; description?: InputMaybe<Scalars["String"]>; displayName: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; symbol?: InputMaybe<Scalars["String"]>; units?: InputMaybe<UnitsInput> }

Input for creating a custom currency

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Metadata associated with the entity

  • currencyId: Scalars["String"]

    The unique identifier for the custom currency

  • Optional description?: InputMaybe<Scalars["String"]>

    Description of the currency

  • displayName: Scalars["String"]

    The name of the custom currency

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional symbol?: InputMaybe<Scalars["String"]>

    The symbol of the custom currency

  • Optional units?: InputMaybe<UnitsInput>

    Units for the currency (singular and plural)

Customer

Customer: { billingId?: string; createdAt: Date; eligibleForTrial?: EligibleForTrial[] | null; email?: string; experimentInfo?: ExperimentInfo | null; hasPaymentMethod: boolean; id: string; metadata?: Metadata | null; name?: string; paymentMethodDetails?: PaymentMethodDetails; promotionalEntitlements: PromotionalEntitlement[]; subscriptions: Subscription[]; trialedPlans?: TrialedPlan[] | null; updatedAt: Date; getActivePromotionalEntitlements: any; getActiveSubscriptions: any; getActiveTrials: any }

Type declaration

CustomerBillingInfo

CustomerBillingInfo: { billingAddress?: InputMaybe<Address>; currency?: InputMaybe<Currency>; customerName?: InputMaybe<Scalars["String"]>; integrationId?: InputMaybe<Scalars["String"]>; invoiceCustomFields?: InputMaybe<Scalars["JSON"]>; language?: InputMaybe<Scalars["String"]>; metadata?: InputMaybe<Scalars["JSON"]>; paymentMethodId?: InputMaybe<Scalars["String"]>; shippingAddress?: InputMaybe<Address>; taxIds?: InputMaybe<TaxExempt[]>; timezone?: InputMaybe<Scalars["String"]> }

Update customer billing information

Type declaration

CustomerFilter

CustomerFilter: { and?: InputMaybe<CustomerFilter[]>; awsMarketplaceCustomerId?: InputMaybe<StringFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmHubspotCompanyId?: InputMaybe<StringFieldComparison>; crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; customerId?: InputMaybe<StringFieldComparison>; deletedAt?: InputMaybe<DateFieldComparison>; email?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<CustomerFilter[]>; promotionalEntitlements?: InputMaybe<CustomerFilterPromotionalEntitlementFilter>; refId?: InputMaybe<StringFieldComparison>; salesforceId?: InputMaybe<StringFieldComparison>; searchQuery?: InputMaybe<CustomerSearchQueryFilterComparison>; subscriptions?: InputMaybe<CustomerFilterCustomerSubscriptionFilter>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

CustomerFilterCustomerSubscriptionFilter

CustomerFilterCustomerSubscriptionFilter: { and?: InputMaybe<CustomerFilterCustomerSubscriptionFilter[]>; billingCycleAnchor?: InputMaybe<DateFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; cancelReason?: InputMaybe<SubscriptionCancelReasonFilterComparison>; cancellationDate?: InputMaybe<DateFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; crmLinkUrl?: InputMaybe<StringFieldComparison>; currentBillingPeriodEnd?: InputMaybe<DateFieldComparison>; currentBillingPeriodStart?: InputMaybe<DateFieldComparison>; customerId?: InputMaybe<UuidFilterComparison>; effectiveEndDate?: InputMaybe<DateFieldComparison>; endDate?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; oldBillingId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<CustomerFilterCustomerSubscriptionFilter[]>; payingCustomerId?: InputMaybe<UuidFilterComparison>; paymentCollection?: InputMaybe<PaymentCollectionFilterComparison>; pricingType?: InputMaybe<PricingTypeFilterComparison>; refId?: InputMaybe<StringFieldComparison>; resourceId?: InputMaybe<UuidFilterComparison>; salesforceId?: InputMaybe<StringFieldComparison>; startDate?: InputMaybe<DateFieldComparison>; status?: InputMaybe<SubscriptionStatusFilterComparison>; subscriptionId?: InputMaybe<StringFieldComparison>; trialEndDate?: InputMaybe<DateFieldComparison> }

Type declaration

CustomerFilterPromotionalEntitlementFilter

CustomerFilterPromotionalEntitlementFilter: { and?: InputMaybe<CustomerFilterPromotionalEntitlementFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<CustomerFilterPromotionalEntitlementFilter[]>; status?: InputMaybe<PromotionalEntitlementStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

CustomerFragment

CustomerFragment: { __typename?: "Customer"; coupon?: ({ __typename?: "Coupon" } & CouponFragment) | null; defaultPaymentExpirationMonth?: number | null; defaultPaymentExpirationYear?: number | null; defaultPaymentMethodLast4Digits?: string | null; defaultPaymentMethodType?: PaymentMethodType | null; eligibleForTrial?: { __typename?: "EligibleForTrial"; eligible: boolean; productId?: string | null; productRefId?: string | null }[] | null; experimentInfo?: { __typename?: "experimentInfo"; groupName: string; groupType: ExperimentGroupType; id: string; name: string } | null; hasActiveSubscription: boolean; hasPaymentMethod: boolean; promotionalEntitlements: ({ __typename?: "PromotionalEntitlement" } & PromotionalEntitlementFragment)[]; trialedPlans?: { __typename?: "TrialedPlan"; planId?: string | null; planRefId?: string | null; productId?: string | null; productRefId?: string | null }[] | null } & SlimCustomerFragment

CustomerInput

CustomerInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; awsMarketplaceCustomerId?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<CustomerBillingInfo>; couponRefId?: InputMaybe<Scalars["String"]>; createdAt?: InputMaybe<Scalars["DateTime"]>; crmId?: InputMaybe<Scalars["String"]>; customerId?: InputMaybe<Scalars["String"]>; email?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; name?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; shouldSyncFree?: InputMaybe<Scalars["Boolean"]> }

Create a new customer

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Additional metadata

  • Optional awsMarketplaceCustomerId?: InputMaybe<Scalars["String"]>

    The AWS Marketplace integration id

  • Optional billingId?: InputMaybe<Scalars["String"]>

    The unique identifier for the entity in the billing provider

  • Optional billingInformation?: InputMaybe<CustomerBillingInfo>

    Customer billing information

  • Optional couponRefId?: InputMaybe<Scalars["String"]>

    Customer level coupon

  • Optional createdAt?: InputMaybe<Scalars["DateTime"]>

    Timestamp of when the record was created

  • Optional crmId?: InputMaybe<Scalars["String"]>

    The unique identifier for the customer in Hubspot integration

  • Optional customerId?: InputMaybe<Scalars["String"]>

    Customer slug

  • Optional email?: InputMaybe<Scalars["String"]>

    The email of the customer

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional name?: InputMaybe<Scalars["String"]>

    The name of the customer

  • Optional refId?: InputMaybe<Scalars["String"]>

    Customer slug

  • Optional salesforceId?: InputMaybe<Scalars["String"]>

    The unique identifier for the customer in Salesforce integration

  • Optional shouldSyncFree?: InputMaybe<Scalars["Boolean"]>

    Wether or not to sync free subscriptions to the billing provider

CustomerPortal

CustomerPortal: { billingInformation: CustomerPortalBillingInformation; billingPortalUrl?: string | null; canUpgradeSubscription: boolean; configuration?: CustomerPortalConfiguration | null; entitlements: CustomerPortalEntitlement[]; promotionalEntitlements: CustomerPortalPromotionalEntitlement[]; resource: CustomerResource | null; showWatermark?: boolean; subscriptions: CustomerPortalSubscription[] }

Type declaration

CustomerPortalBillingInformation

CustomerPortalBillingInformation: Omit<CustomerPortalBillingInformationFragment, "__typename">

CustomerPortalBillingInformationFragment

CustomerPortalBillingInformationFragment: { __typename?: "CustomerPortalBillingInformation"; defaultPaymentExpirationMonth?: number | null; defaultPaymentExpirationYear?: number | null; defaultPaymentMethodId?: string | null; defaultPaymentMethodLast4Digits?: string | null; defaultPaymentMethodType?: PaymentMethodType | null; email?: string | null; name?: string | null }

Type declaration

  • Optional __typename?: "CustomerPortalBillingInformation"
  • Optional defaultPaymentExpirationMonth?: number | null
  • Optional defaultPaymentExpirationYear?: number | null
  • Optional defaultPaymentMethodId?: string | null
  • Optional defaultPaymentMethodLast4Digits?: string | null
  • Optional defaultPaymentMethodType?: PaymentMethodType | null
  • Optional email?: string | null
  • Optional name?: string | null

CustomerPortalColorsPaletteInput

CustomerPortalColorsPaletteInput: { backgroundColor?: InputMaybe<Scalars["String"]>; borderColor?: InputMaybe<Scalars["String"]>; currentPlanBackground?: InputMaybe<Scalars["String"]>; iconsColor?: InputMaybe<Scalars["String"]>; paywallBackgroundColor?: InputMaybe<Scalars["String"]>; primary?: InputMaybe<Scalars["String"]>; textColor?: InputMaybe<Scalars["String"]> }

Input for customizing customer portal color palette.

Type declaration

  • Optional backgroundColor?: InputMaybe<Scalars["String"]>

    Background color of the widget.

  • Optional borderColor?: InputMaybe<Scalars["String"]>

    Color applied to widget borders or separators.

  • Optional currentPlanBackground?: InputMaybe<Scalars["String"]>

    Background color for the customer’s current plan section in the paywall.

  • Optional iconsColor?: InputMaybe<Scalars["String"]>

    Color used for icons in the customer portal.

  • Optional paywallBackgroundColor?: InputMaybe<Scalars["String"]>

    Background color for embedded paywall sections inside the customer portal.

  • Optional primary?: InputMaybe<Scalars["String"]>

    Primary accent color used throughout the widget.

  • Optional textColor?: InputMaybe<Scalars["String"]>

    Default color used for text content.

CustomerPortalConfiguration

CustomerPortalConfiguration: Omit<CustomerPortalConfigurationFragment, "__typename">

CustomerPortalConfigurationFragment

CustomerPortalConfigurationFragment: { __typename?: "CustomerPortalConfiguration"; customCss?: string | null; palette?: { __typename?: "CustomerPortalColorsPalette"; backgroundColor?: string | null; borderColor?: string | null; currentPlanBackground?: string | null; iconsColor?: string | null; paywallBackgroundColor?: string | null; primary?: string | null; textColor?: string | null } | null; typography?: ({ __typename?: "TypographyConfiguration" } & TypographyConfigurationFragment) | null }

Type declaration

  • Optional __typename?: "CustomerPortalConfiguration"
  • Optional customCss?: string | null
  • Optional palette?: { __typename?: "CustomerPortalColorsPalette"; backgroundColor?: string | null; borderColor?: string | null; currentPlanBackground?: string | null; iconsColor?: string | null; paywallBackgroundColor?: string | null; primary?: string | null; textColor?: string | null } | null
  • Optional typography?: ({ __typename?: "TypographyConfiguration" } & TypographyConfigurationFragment) | null

CustomerPortalConfigurationInput

CustomerPortalConfigurationInput: { customCss?: InputMaybe<Scalars["String"]>; palette?: InputMaybe<CustomerPortalColorsPaletteInput>; typography?: InputMaybe<TypographyConfigurationInput> }

Input for configuring the customer portal appearance.

Type declaration

CustomerPortalEntitlement

CustomerPortalEntitlement: Omit<CustomerPortalEntitlementFragment, "__typename">

CustomerPortalEntitlementFragment

CustomerPortalEntitlementFragment: { __typename?: "Entitlement"; currentUsage?: number | null; feature?: ({ __typename?: "EntitlementFeature" } & FeatureFragment) | null; hasSoftLimit?: boolean | null; hasUnlimitedUsage: boolean; isGranted: boolean; nextResetDate?: any | null; resetPeriod?: EntitlementResetPeriod | null; resetPeriodConfiguration?: ({ __typename?: "MonthlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_) | ({ __typename?: "WeeklyResetPeriodConfig" } & ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_) | ({ __typename?: "YearlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_) | null; usageLimit?: number | null; usagePeriodEnd?: any | null; usagePeriodStart?: any | null }

Type declaration

  • Optional __typename?: "Entitlement"
  • Optional currentUsage?: number | null
  • Optional feature?: ({ __typename?: "EntitlementFeature" } & FeatureFragment) | null
  • Optional hasSoftLimit?: boolean | null
  • hasUnlimitedUsage: boolean
  • isGranted: boolean
  • Optional nextResetDate?: any | null
  • Optional resetPeriod?: EntitlementResetPeriod | null
  • Optional resetPeriodConfiguration?: ({ __typename?: "MonthlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_) | ({ __typename?: "WeeklyResetPeriodConfig" } & ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_) | ({ __typename?: "YearlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_) | null
  • Optional usageLimit?: number | null
  • Optional usagePeriodEnd?: any | null
  • Optional usagePeriodStart?: any | null

CustomerPortalFragment

CustomerPortalFragment: { __typename?: "CustomerPortal"; billingInformation: { __typename?: "CustomerPortalBillingInformation" } & CustomerPortalBillingInformationFragment; billingPortalUrl?: string | null; canUpgradeSubscription: boolean; configuration?: ({ __typename?: "CustomerPortalConfiguration" } & CustomerPortalConfigurationFragment) | null; entitlements: ({ __typename?: "Entitlement" } & CustomerPortalEntitlementFragment)[]; promotionalEntitlements: ({ __typename?: "CustomerPortalPromotionalEntitlement" } & CustomerPortalPromotionalEntitlementFragment)[]; resource?: ({ __typename?: "CustomerResource" } & CustomerResourceFragment) | null; showWatermark: boolean; subscriptions: ({ __typename?: "CustomerPortalSubscription" } & CustomerPortalSubscriptionFragment)[] }

Type declaration

CustomerPortalInput

CustomerPortalInput: { customerId: Scalars["String"]; productId?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]> }

Optional explanation or context for why this portal session is being initialized.

Type declaration

  • customerId: Scalars["String"]

    Unique identifier of the customer.

  • Optional productId?: InputMaybe<Scalars["String"]>

    The ID of the product context under which the portal is rendered.

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    Unique identifier of a resource if the subscription or entitlements are scoped to a specific resource.

CustomerPortalPromotionalEntitlement

CustomerPortalPromotionalEntitlement: Omit<CustomerPortalPromotionalEntitlementFragment, "__typename">

CustomerPortalPromotionalEntitlementFragment

CustomerPortalPromotionalEntitlementFragment: { __typename?: "CustomerPortalPromotionalEntitlement"; displayName: string; endDate?: any | null; hasSoftLimit?: boolean | null; hasUnlimitedUsage?: boolean | null; period: PromotionalEntitlementPeriod; startDate: any; usageLimit?: number | null }

Type declaration

  • Optional __typename?: "CustomerPortalPromotionalEntitlement"
  • displayName: string
  • Optional endDate?: any | null
  • Optional hasSoftLimit?: boolean | null
  • Optional hasUnlimitedUsage?: boolean | null
  • period: PromotionalEntitlementPeriod
  • startDate: any
  • Optional usageLimit?: number | null

CustomerPortalSubscription

CustomerPortalSubscription: Omit<CustomerPortalSubscriptionFragment, "__typename">

CustomerPortalSubscriptionAddon

CustomerPortalSubscriptionAddon: Omit<CustomerPortalSubscriptionAddonFragment, "__typename">

CustomerPortalSubscriptionAddonFragment

CustomerPortalSubscriptionAddonFragment: { __typename?: "CustomerPortalAddon"; addonId: string; description?: string | null; displayName: string; quantity: number }

Type declaration

  • Optional __typename?: "CustomerPortalAddon"
  • addonId: string
  • Optional description?: string | null
  • displayName: string
  • quantity: number

CustomerPortalSubscriptionFragment

CustomerPortalSubscriptionFragment: { __typename?: "CustomerPortalSubscription"; addons: ({ __typename?: "CustomerPortalAddon" } & CustomerPortalSubscriptionAddonFragment)[]; billingPeriodRange?: { __typename?: "DateRange"; end?: any | null; start?: any | null } | null; planId: string; planName: string; prices: ({ __typename?: "CustomerPortalSubscriptionPrice" } & CustomerPortalSubscriptionPriceFragment)[]; pricing: { __typename?: "CustomerPortalSubscriptionPricing"; billingModel?: BillingModel | null; billingPeriod?: BillingPeriod | null; creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string } | null; feature?: { __typename?: "CustomerPortalPricingFeature"; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null } | null; price?: { __typename?: "Money"; amount: number; currency: Currency } | null; pricingType: PricingType; unitQuantity?: number | null; usageBasedEstimatedBill?: number | null }; pricingType: PricingType; scheduledUpdates?: ({ __typename?: "SubscriptionScheduledUpdate" } & CustomerPortalSubscriptionScheduledUpdateDataFragment)[] | null; status: SubscriptionStatus; subscriptionId: string; totalPrice?: { __typename?: "CustomerSubscriptionTotalPrice"; addonsTotal: { __typename?: "Money"; amount: number; currency: Currency }; subTotal: { __typename?: "Money"; amount: number; currency: Currency }; total: { __typename?: "Money"; amount: number; currency: Currency } } | null; trialRemainingDays?: number | null }

Type declaration

  • Optional __typename?: "CustomerPortalSubscription"
  • addons: ({ __typename?: "CustomerPortalAddon" } & CustomerPortalSubscriptionAddonFragment)[]
  • Optional billingPeriodRange?: { __typename?: "DateRange"; end?: any | null; start?: any | null } | null
  • planId: string
  • planName: string
  • prices: ({ __typename?: "CustomerPortalSubscriptionPrice" } & CustomerPortalSubscriptionPriceFragment)[]
  • pricing: { __typename?: "CustomerPortalSubscriptionPricing"; billingModel?: BillingModel | null; billingPeriod?: BillingPeriod | null; creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string } | null; feature?: { __typename?: "CustomerPortalPricingFeature"; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null } | null; price?: { __typename?: "Money"; amount: number; currency: Currency } | null; pricingType: PricingType; unitQuantity?: number | null; usageBasedEstimatedBill?: number | null }
    • Optional __typename?: "CustomerPortalSubscriptionPricing"
    • Optional billingModel?: BillingModel | null
    • Optional billingPeriod?: BillingPeriod | null
    • Optional creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string } | null
    • Optional feature?: { __typename?: "CustomerPortalPricingFeature"; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null } | null
    • Optional price?: { __typename?: "Money"; amount: number; currency: Currency } | null
    • pricingType: PricingType
    • Optional unitQuantity?: number | null
    • Optional usageBasedEstimatedBill?: number | null
  • pricingType: PricingType
  • Optional scheduledUpdates?: ({ __typename?: "SubscriptionScheduledUpdate" } & CustomerPortalSubscriptionScheduledUpdateDataFragment)[] | null
  • status: SubscriptionStatus
  • subscriptionId: string
  • Optional totalPrice?: { __typename?: "CustomerSubscriptionTotalPrice"; addonsTotal: { __typename?: "Money"; amount: number; currency: Currency }; subTotal: { __typename?: "Money"; amount: number; currency: Currency }; total: { __typename?: "Money"; amount: number; currency: Currency } } | null
  • Optional trialRemainingDays?: number | null

CustomerPortalSubscriptionPriceFragment

CustomerPortalSubscriptionPriceFragment: { __typename?: "CustomerPortalSubscriptionPrice"; billingModel?: BillingModel | null; billingPeriod?: BillingPeriod | null; blockSize?: number | null; creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string } | null; feature?: { __typename?: "CustomerPortalPricingFeature"; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; id: any; refId: string } | null; price?: { __typename?: "Money"; amount: number; currency: Currency } | null }

Type declaration

  • Optional __typename?: "CustomerPortalSubscriptionPrice"
  • Optional billingModel?: BillingModel | null
  • Optional billingPeriod?: BillingPeriod | null
  • Optional blockSize?: number | null
  • Optional creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string } | null
  • Optional feature?: { __typename?: "CustomerPortalPricingFeature"; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; id: any; refId: string } | null
  • Optional price?: { __typename?: "Money"; amount: number; currency: Currency } | null

CustomerPortalSubscriptionScheduledUpdateDataFragment

CustomerPortalSubscriptionScheduledUpdateDataFragment: { __typename?: "SubscriptionScheduledUpdate"; scheduleStatus: SubscriptionScheduleStatus; scheduleVariables?: ({ __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_) | ({ __typename?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_) | ({ __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_) | ({ __typename?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_) | ({ __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_) | ({ __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_) | ({ __typename?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_) | ({ __typename?: "RecurringCreditsChangeVariables" } & ScheduleVariablesFragment_RecurringCreditsChangeVariables_) | ({ __typename?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_) | null; scheduledExecutionTime: any; subscriptionScheduleType: SubscriptionScheduleType; targetPackage?: { __typename?: "PackageDTO"; displayName: string; id: any; pricingType?: PricingType | null; refId: string } | null }

Type declaration

  • Optional __typename?: "SubscriptionScheduledUpdate"
  • scheduleStatus: SubscriptionScheduleStatus
  • Optional scheduleVariables?: ({ __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_) | ({ __typename?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_) | ({ __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_) | ({ __typename?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_) | ({ __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_) | ({ __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_) | ({ __typename?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_) | ({ __typename?: "RecurringCreditsChangeVariables" } & ScheduleVariablesFragment_RecurringCreditsChangeVariables_) | ({ __typename?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_) | null
  • scheduledExecutionTime: any
  • subscriptionScheduleType: SubscriptionScheduleType
  • Optional targetPackage?: { __typename?: "PackageDTO"; displayName: string; id: any; pricingType?: PricingType | null; refId: string } | null

CustomerResource

CustomerResource: { id: string }

Type declaration

  • id: string

CustomerResourceFilter

CustomerResourceFilter: { and?: InputMaybe<CustomerResourceFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; customer?: InputMaybe<CustomerResourceFilterCustomerFilter>; environmentId?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<CustomerResourceFilter[]>; resourceId?: InputMaybe<StringFieldComparison>; subscriptions?: InputMaybe<CustomerResourceFilterCustomerSubscriptionFilter> }

Type declaration

CustomerResourceFilterCustomerFilter

CustomerResourceFilterCustomerFilter: { and?: InputMaybe<CustomerResourceFilterCustomerFilter[]>; awsMarketplaceCustomerId?: InputMaybe<StringFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmHubspotCompanyId?: InputMaybe<StringFieldComparison>; crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; customerId?: InputMaybe<StringFieldComparison>; deletedAt?: InputMaybe<DateFieldComparison>; email?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<CustomerResourceFilterCustomerFilter[]>; refId?: InputMaybe<StringFieldComparison>; salesforceId?: InputMaybe<StringFieldComparison>; searchQuery?: InputMaybe<CustomerSearchQueryFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

CustomerResourceFilterCustomerSubscriptionFilter

CustomerResourceFilterCustomerSubscriptionFilter: { and?: InputMaybe<CustomerResourceFilterCustomerSubscriptionFilter[]>; billingCycleAnchor?: InputMaybe<DateFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; cancelReason?: InputMaybe<SubscriptionCancelReasonFilterComparison>; cancellationDate?: InputMaybe<DateFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; crmLinkUrl?: InputMaybe<StringFieldComparison>; currentBillingPeriodEnd?: InputMaybe<DateFieldComparison>; currentBillingPeriodStart?: InputMaybe<DateFieldComparison>; customerId?: InputMaybe<UuidFilterComparison>; effectiveEndDate?: InputMaybe<DateFieldComparison>; endDate?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; oldBillingId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<CustomerResourceFilterCustomerSubscriptionFilter[]>; payingCustomerId?: InputMaybe<UuidFilterComparison>; paymentCollection?: InputMaybe<PaymentCollectionFilterComparison>; pricingType?: InputMaybe<PricingTypeFilterComparison>; refId?: InputMaybe<StringFieldComparison>; resourceId?: InputMaybe<UuidFilterComparison>; salesforceId?: InputMaybe<StringFieldComparison>; startDate?: InputMaybe<DateFieldComparison>; status?: InputMaybe<SubscriptionStatusFilterComparison>; subscriptionId?: InputMaybe<StringFieldComparison>; trialEndDate?: InputMaybe<DateFieldComparison> }

Type declaration

CustomerResourceFragment

CustomerResourceFragment: { __typename?: "CustomerResource"; resourceId: string }

Type declaration

  • Optional __typename?: "CustomerResource"
  • resourceId: string

CustomerResourceSort

CustomerResourceSort: { direction: SortDirection; field: CustomerResourceSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

CustomerSearchQueryFilterComparison

CustomerSearchQueryFilterComparison: { iLike?: InputMaybe<Scalars["String"]> }

Type declaration

CustomerSort

CustomerSort: { direction: SortDirection; field: CustomerSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

CustomerState

CustomerState: Omit<Customer, "getActiveSubscriptions" | "getActivePromotionalEntitlements" | "getActiveTrials">

CustomerStatisticsFragment

CustomerStatisticsFragment: { __typename?: "Customer"; statistics?: { __typename?: "CustomerStatistics"; activeSubscriptionsByPricingType: { __typename?: "SubscriptionPricingTypeStatistics"; pricingType: PricingType; totalCount: number }[] } | null }

Type declaration

  • Optional __typename?: "Customer"
  • Optional statistics?: { __typename?: "CustomerStatistics"; activeSubscriptionsByPricingType: { __typename?: "SubscriptionPricingTypeStatistics"; pricingType: PricingType; totalCount: number }[] } | null

CustomerSubscriptionFilter

CustomerSubscriptionFilter: { addons?: InputMaybe<CustomerSubscriptionFilterSubscriptionAddonFilter>; and?: InputMaybe<CustomerSubscriptionFilter[]>; billingCycleAnchor?: InputMaybe<DateFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; cancelReason?: InputMaybe<SubscriptionCancelReasonFilterComparison>; cancellationDate?: InputMaybe<DateFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; crmLinkUrl?: InputMaybe<StringFieldComparison>; currentBillingPeriodEnd?: InputMaybe<DateFieldComparison>; currentBillingPeriodStart?: InputMaybe<DateFieldComparison>; customer?: InputMaybe<CustomerSubscriptionFilterCustomerFilter>; customerId?: InputMaybe<UuidFilterComparison>; effectiveEndDate?: InputMaybe<DateFieldComparison>; endDate?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; oldBillingId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<CustomerSubscriptionFilter[]>; payingCustomer?: InputMaybe<CustomerSubscriptionFilterCustomerFilter>; payingCustomerId?: InputMaybe<UuidFilterComparison>; paymentCollection?: InputMaybe<PaymentCollectionFilterComparison>; plan?: InputMaybe<CustomerSubscriptionFilterPlanFilter>; prices?: InputMaybe<CustomerSubscriptionFilterSubscriptionPriceFilter>; pricingType?: InputMaybe<PricingTypeFilterComparison>; refId?: InputMaybe<StringFieldComparison>; resource?: InputMaybe<CustomerSubscriptionFilterCustomerResourceFilter>; resourceId?: InputMaybe<UuidFilterComparison>; salesforceId?: InputMaybe<StringFieldComparison>; startDate?: InputMaybe<DateFieldComparison>; status?: InputMaybe<SubscriptionStatusFilterComparison>; subscriptionEntitlements?: InputMaybe<CustomerSubscriptionFilterSubscriptionEntitlementFilter>; subscriptionId?: InputMaybe<StringFieldComparison>; trialEndDate?: InputMaybe<DateFieldComparison> }

Type declaration

CustomerSubscriptionFilterCustomerFilter

CustomerSubscriptionFilterCustomerFilter: { and?: InputMaybe<CustomerSubscriptionFilterCustomerFilter[]>; awsMarketplaceCustomerId?: InputMaybe<StringFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmHubspotCompanyId?: InputMaybe<StringFieldComparison>; crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; customerId?: InputMaybe<StringFieldComparison>; deletedAt?: InputMaybe<DateFieldComparison>; email?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<CustomerSubscriptionFilterCustomerFilter[]>; refId?: InputMaybe<StringFieldComparison>; salesforceId?: InputMaybe<StringFieldComparison>; searchQuery?: InputMaybe<CustomerSearchQueryFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

CustomerSubscriptionFilterCustomerResourceFilter

CustomerSubscriptionFilterCustomerResourceFilter: { and?: InputMaybe<CustomerSubscriptionFilterCustomerResourceFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<CustomerSubscriptionFilterCustomerResourceFilter[]>; resourceId?: InputMaybe<StringFieldComparison> }

Type declaration

CustomerSubscriptionFilterPlanFilter

CustomerSubscriptionFilterPlanFilter: { and?: InputMaybe<CustomerSubscriptionFilterPlanFilter[]>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<CustomerSubscriptionFilterPlanFilter[]>; pricingType?: InputMaybe<PricingTypeFilterComparison>; productId?: InputMaybe<StringFieldComparison>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<PackageStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

CustomerSubscriptionFilterSubscriptionAddonFilter

CustomerSubscriptionFilterSubscriptionAddonFilter: { and?: InputMaybe<CustomerSubscriptionFilterSubscriptionAddonFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<CustomerSubscriptionFilterSubscriptionAddonFilter[]>; quantity?: InputMaybe<NumberFieldComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

CustomerSubscriptionFilterSubscriptionEntitlementFilter

CustomerSubscriptionFilterSubscriptionEntitlementFilter: { and?: InputMaybe<CustomerSubscriptionFilterSubscriptionEntitlementFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<CustomerSubscriptionFilterSubscriptionEntitlementFilter[]>; subscriptionId?: InputMaybe<StringFieldComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

CustomerSubscriptionFilterSubscriptionPriceFilter

CustomerSubscriptionFilterSubscriptionPriceFilter: { and?: InputMaybe<CustomerSubscriptionFilterSubscriptionPriceFilter[]>; billingModel?: InputMaybe<BillingModelFilterComparison>; createdAt?: InputMaybe<DateFieldComparison>; featureId?: InputMaybe<StringFieldComparison>; hasSoftLimit?: InputMaybe<BooleanFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<CustomerSubscriptionFilterSubscriptionPriceFilter[]>; updatedAt?: InputMaybe<DateFieldComparison>; usageLimit?: InputMaybe<NumberFieldComparison> }

Type declaration

CustomerSubscriptionSort

CustomerSubscriptionSort: { direction: SortDirection; field: CustomerSubscriptionSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

CustomerWithSubscriptionsFragment

CustomerWithSubscriptionsFragment: { __typename?: "Customer"; subscriptions?: ({ __typename?: "CustomerSubscription" } & SubscriptionFragment)[] | null } & CustomerFragment

DateFieldComparison

DateFieldComparison: { between?: InputMaybe<DateFieldComparisonBetween>; eq?: InputMaybe<Scalars["DateTime"]>; gt?: InputMaybe<Scalars["DateTime"]>; gte?: InputMaybe<Scalars["DateTime"]>; in?: InputMaybe<Scalars["DateTime"][]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; lt?: InputMaybe<Scalars["DateTime"]>; lte?: InputMaybe<Scalars["DateTime"]>; neq?: InputMaybe<Scalars["DateTime"]>; notBetween?: InputMaybe<DateFieldComparisonBetween>; notIn?: InputMaybe<Scalars["DateTime"][]> }

Type declaration

DateFieldComparisonBetween

DateFieldComparisonBetween: { lower: Scalars["DateTime"]; upper: Scalars["DateTime"] }

Type declaration

DateRange

DateRange: { end?: Date; start?: Date }

Type declaration

  • Optional end?: Date
  • Optional start?: Date

DefaultSsoRolesInput

DefaultSsoRolesInput: { accountRole: AccountAccessRole; nonProductionRole: EnvironmentAccessRole; productionRole: EnvironmentAccessRole }

Input type for default SSO roles

Type declaration

DefaultTrialConfig

DefaultTrialConfig: { budget?: { limit: BudgetConfigurationInput["limit"] }; duration: number; units: TrialPeriodUnits }

Type declaration

DefaultTrialConfigInputDto

DefaultTrialConfigInputDto: { budget?: InputMaybe<BudgetConfigurationInput>; duration?: InputMaybe<Scalars["Float"]>; trialEndBehavior?: InputMaybe<TrialEndBehavior>; units?: InputMaybe<TrialPeriodUnits> }

Default configuration for a trial

Type declaration

DelegateSubscriptionToCustomerInput

DelegateSubscriptionToCustomerInput: { destinationCustomerId?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; subscriptionId: Scalars["String"] }

The input for delegating a subscription to a customer

Type declaration

  • Optional destinationCustomerId?: InputMaybe<Scalars["String"]>

    The customer ID which will manage the subscription (the paying customer of the subscription will not change)

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The environment ID of the subscription to delegate

  • subscriptionId: Scalars["String"]

    The ID of the subscription to delegate

DelegateSubscriptionToCustomerMutation

DelegateSubscriptionToCustomerMutation: { __typename?: "Mutation"; delegateSubscriptionToCustomer: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • delegateSubscriptionToCustomer: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment

DelegateSubscriptionToCustomerMutationVariables

DelegateSubscriptionToCustomerMutationVariables: Exact<{ input: DelegateSubscriptionToCustomerInput }>

DeleteFeatureInput

DeleteFeatureInput: { environmentId?: InputMaybe<Scalars["UUID"]>; id: Scalars["String"] }

Input for deleting a feature

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • id: Scalars["String"]

    Unique identifier for the entity

DeleteOneHookInput

DeleteOneHookInput: { id: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record to delete.

DeleteOneIntegrationInput

DeleteOneIntegrationInput: { id: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record to delete.

DeleteOnePackageEntitlementInput

DeleteOnePackageEntitlementInput: { id: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record to delete.

DeleteOnePriceInput

DeleteOnePriceInput: { id: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record to delete.

DeleteOneProductInput

DeleteOneProductInput: { id: Scalars["String"] }

Input for deleting a product

Type declaration

  • id: Scalars["String"]

    Unique identifier for the entity

DeleteOnePromotionalEntitlementInput

DeleteOnePromotionalEntitlementInput: { id: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record to delete.

DeletePackageEntitlementInput

DeletePackageEntitlementInput: { id: Scalars["UUID"] }

Delete package entitlement input

Type declaration

  • id: Scalars["UUID"]

    Unique identifier for the entity

DeleteWorkflowTriggerInput

DeleteWorkflowTriggerInput: { environmentId?: InputMaybe<Scalars["UUID"]>; workflowTriggerId: Scalars["String"] }

Delete workflow trigger input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • workflowTriggerId: Scalars["String"]

    Workflow trigger id

DependencyAddon

DependencyAddon: { description?: string; displayName: string; refId: string }

Type declaration

  • Optional description?: string
  • displayName: string
  • refId: string

DetachCustomerPaymentMethodInput

DetachCustomerPaymentMethodInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]> }

Remove a payment method from a customer

Type declaration

  • customerId: Scalars["String"]

    Customer slug

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

DetachCustomerPaymentMethodMutation

DetachCustomerPaymentMethodMutation: { __typename?: "Mutation"; detachCustomerPaymentMethod: { __typename?: "Customer" } & SlimCustomerFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • detachCustomerPaymentMethod: { __typename?: "Customer" } & SlimCustomerFragment

DetachCustomerPaymentMethodMutationVariables

DetachCustomerPaymentMethodMutationVariables: Exact<{ input: DetachCustomerPaymentMethodInput }>

DimensionsMappingInput

DimensionsMappingInput: { key: Scalars["String"]; planName: Scalars["String"]; planRefId: Scalars["String"] }

Configuration for mapping AWS Marketplace dimensions to Stigg plans

Type declaration

  • key: Scalars["String"]

    AWS dimension key for the mapping

  • planName: Scalars["String"]

    Corresponding Stigg plan name for feature management

  • planRefId: Scalars["String"]

    Reference ID of the corresponding Stigg plan

DiscardPackageDraftInput

DiscardPackageDraftInput: { environmentId: Scalars["String"]; refId: Scalars["String"] }

Discard Package Draft Input

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • refId: Scalars["String"]

    The unique identifier for the entity

DoesFeatureExist

DoesFeatureExist: { environmentId: Scalars["UUID"]; refId: Scalars["String"] }

Input for checking if a feature exists

Type declaration

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • refId: Scalars["String"]

    The unique identifier for the feature

DumpEnvironmentForForMergeComparisonInput

DumpEnvironmentForForMergeComparisonInput: { destinationEnvironmentSlug: Scalars["String"]; mergeConfiguration?: InputMaybe<EnvironmentMergeConfigurationInput>; sourceEnvironmentSlug: Scalars["String"] }

Input for dumping two environments for comparison before a merge

Type declaration

DumpEnvironmentProductCatalogInput

DumpEnvironmentProductCatalogInput: { environmentSlug: Scalars["String"] }

Input type for dumpEnvironmentProductCatalog mutation

Type declaration

  • environmentSlug: Scalars["String"]

    The slug of the environment to dump

DuplicateProductInput

DuplicateProductInput: { description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; environmentId: Scalars["String"]; refId: Scalars["String"]; sourceProductId: Scalars["String"] }

Input for duplicating a product

Type declaration

  • Optional description?: InputMaybe<Scalars["String"]>

    Description of the new product

  • Optional displayName?: InputMaybe<Scalars["String"]>

    Display name of the new product

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • refId: Scalars["String"]

    The unique identifier for the entity

  • sourceProductId: Scalars["String"]

    ID of the product to duplicate

EditPackageGroupDetailsInput

EditPackageGroupDetailsInput: { description?: InputMaybe<Scalars["String"]>; displayName: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; packageGroupId: Scalars["String"] }

The input type for editing a package group details

Type declaration

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the package group

  • displayName: Scalars["String"]

    The display name of the package group

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • packageGroupId: Scalars["String"]

    The id of the package group

EligibleForTrial

EligibleForTrial: { eligible: boolean; productId?: string | null }

Type declaration

  • eligible: boolean
  • Optional productId?: string | null

Entitlement

Entitlement: BooleanEntitlement | NumericEntitlement | MeteredEntitlement

EntitlementCheckRequested

EntitlementCheckRequested: { customerId: Scalars["String"]; entitlementCheckResult: EntitlementCheckResult; environmentId?: InputMaybe<Scalars["UUID"]>; featureId: Scalars["String"]; requestedUsage?: InputMaybe<Scalars["Float"]>; requestedValues?: InputMaybe<Scalars["String"][]>; resourceId?: InputMaybe<Scalars["String"]> }

Input used to report that an entitlement check was performed for a customer.

Type declaration

  • customerId: Scalars["String"]

    Identifier of the customer for whom the entitlement check was made.

  • entitlementCheckResult: EntitlementCheckResult

    Result object of an entitlement access check.

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The environment context in which the check occurred.

  • featureId: Scalars["String"]

    The internal ID of the feature linked to this entitlement.

  • Optional requestedUsage?: InputMaybe<Scalars["Float"]>

    The amount of usage requested by the customer.

  • Optional requestedValues?: InputMaybe<Scalars["String"][]>

    The values requested by the customer, if applicable.

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The specific resource identifier scoped for the entitlement check.

EntitlementCheckResult

EntitlementCheckResult: { accessDeniedReason?: InputMaybe<AccessDeniedReason>; currentUsage?: InputMaybe<Scalars["Float"]>; enumValues?: InputMaybe<Scalars["String"][]>; hasAccess: Scalars["Boolean"]; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; nextResetDate?: InputMaybe<Scalars["DateTime"]>; requestedUsage?: InputMaybe<Scalars["Float"]>; requestedValues?: InputMaybe<Scalars["String"][]>; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Result object of an entitlement access check.

Type declaration

  • Optional accessDeniedReason?: InputMaybe<AccessDeniedReason>

    Optional message explaining why access to the feature is denied.

  • Optional currentUsage?: InputMaybe<Scalars["Float"]>

    The amount of the feature the customer has used so far in the current period.

  • Optional enumValues?: InputMaybe<Scalars["String"][]>

    List of enum values applicable to this entitlement, if it is an enum feature.

  • hasAccess: Scalars["Boolean"]

    Indicates whether the customer currently has access to the feature.

  • Optional hasSoftLimit?: InputMaybe<Scalars["Boolean"]>

    Indicates whether the usage limit is soft — usage can exceed the limit, but will be tracked.

  • Optional hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>

    Indicates whether this entitlement grants unlimited usage with no enforced cap.

  • Optional monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>

    Configuration for monthly usage reset.

  • Optional nextResetDate?: InputMaybe<Scalars["DateTime"]>

    The next date when the entitlement usage resets.

  • Optional requestedUsage?: InputMaybe<Scalars["Float"]>

    The amount of usage requested by the customer.

  • Optional requestedValues?: InputMaybe<Scalars["String"][]>

    The values requested by the customer, if applicable.

  • Optional resetPeriod?: InputMaybe<EntitlementResetPeriod>

    The interval at which usage resets automatically, such as monthly or yearly.

  • Optional usageLimit?: InputMaybe<Scalars["Float"]>

    The maximum allowed usage for this entitlement before restrictions apply.

  • Optional weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>

    Configuration for weekly usage reset.

  • Optional yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>

    Configuration for yearly usage reset.

EntitlementFeature

EntitlementFeature: { 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
  • featureType: FeatureType
  • id: string
  • Optional isMetered?: boolean
  • Optional metadata?: Record<string, string>
  • Optional meterType?: Fluctuating | Incremental | None
  • Optional units?: string
  • Optional unitsPlural?: string

EntitlementFragment

EntitlementFragment: { __typename: "Entitlement"; accessDeniedReason?: AccessDeniedReason | null; creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string } | null; currentUsage?: number | null; customerId?: string | null; entitlementUpdatedAt?: any | null; enumValues?: string[] | null; feature?: ({ __typename?: "EntitlementFeature" } & FeatureFragment) | null; hasSoftLimit?: boolean | null; hasUnlimitedUsage: boolean; isGranted: boolean; nextResetDate?: any | null; requestedUsage?: number | null; requestedValues?: string[] | null; resetPeriod?: EntitlementResetPeriod | null; resetPeriodConfiguration?: ({ __typename?: "MonthlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_) | ({ __typename?: "WeeklyResetPeriodConfig" } & ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_) | ({ __typename?: "YearlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_) | null; resourceId?: string | null; usageLimit?: number | null; usagePeriodAnchor?: any | null; usagePeriodEnd?: any | null; usagePeriodStart?: any | null; usageUpdatedAt?: any | null; validUntil?: number | null }

Type declaration

  • __typename: "Entitlement"
  • Optional accessDeniedReason?: AccessDeniedReason | null
  • Optional creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string } | null
  • Optional currentUsage?: number | null
  • Optional customerId?: string | null
  • Optional entitlementUpdatedAt?: any | null
  • Optional enumValues?: string[] | null
  • Optional feature?: ({ __typename?: "EntitlementFeature" } & FeatureFragment) | null
  • Optional hasSoftLimit?: boolean | null
  • hasUnlimitedUsage: boolean
  • isGranted: boolean
  • Optional nextResetDate?: any | null
  • Optional requestedUsage?: number | null
  • Optional requestedValues?: string[] | null
  • Optional resetPeriod?: EntitlementResetPeriod | null
  • Optional resetPeriodConfiguration?: ({ __typename?: "MonthlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_) | ({ __typename?: "WeeklyResetPeriodConfig" } & ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_) | ({ __typename?: "YearlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_) | null
  • Optional resourceId?: string | null
  • Optional usageLimit?: number | null
  • Optional usagePeriodAnchor?: any | null
  • Optional usagePeriodEnd?: any | null
  • Optional usagePeriodStart?: any | null
  • Optional usageUpdatedAt?: any | null
  • Optional validUntil?: number | null

EntitlementOptions

EntitlementOptions: { requestedUsage?: InputMaybe<Scalars["Float"]>; requestedValues?: InputMaybe<Scalars["String"][]>; shouldTrack?: InputMaybe<Scalars["Boolean"]> }

Options for configuring how an entitlement is tracked or applied.

Type declaration

  • Optional requestedUsage?: InputMaybe<Scalars["Float"]>

    The amount of usage requested by the customer.

  • Optional requestedValues?: InputMaybe<Scalars["String"][]>

    The values requested by the customer, if applicable.

  • Optional shouldTrack?: InputMaybe<Scalars["Boolean"]>

    Not in use anymore

EntitlementUsageUpdatedFragment

EntitlementUsageUpdatedFragment: { __typename?: "UsageUpdated"; entitlement: { __typename?: "Entitlement" } & EntitlementFragment; usage: { __typename?: "UsageMeasurementUpdated" } & UsageUpdatedFragment }

Type declaration

EntitlementsFallback

EntitlementsFallback: {}

Type declaration

EntitlementsState

EntitlementsState: { accessDeniedReason: EntitlementsStateAccessDeniedReason | null; entitlements: Entitlement[] }

Type declaration

EntitlementsUpdatedPayloadFragment

EntitlementsUpdatedPayloadFragment: { __typename?: "EntitlementsUpdated"; accessDeniedReason?: EntitlementsStateAccessDeniedReason | null; customerId: string; entitlements: ({ __typename?: "Entitlement" } & EntitlementFragment)[]; resourceId?: string | null }

Type declaration

EnumConfigurationEntityInput

EnumConfigurationEntityInput: { displayName: Scalars["String"]; value: Scalars["String"] }

Feature enum configuration entity

Type declaration

  • displayName: Scalars["String"]

    The display name for the enum configuration entity

  • value: Scalars["String"]

    The unique value identifier for the enum configuration entity

EnumEntitlementFallback

EnumEntitlementFallback: { enumValues?: string[]; hasAccess: boolean }

Type declaration

  • Optional enumValues?: string[]
  • hasAccess: boolean

EnumEntitlementOptions

EnumEntitlementOptions: { fallback?: EnumEntitlementFallback; requestedValues?: string[]; shouldTrack?: boolean }

Type declaration

  • Optional fallback?: EnumEntitlementFallback
  • Optional requestedValues?: string[]
  • Optional shouldTrack?: boolean
    deprecated

    not in use anymore

EnvironmentFilter

EnvironmentFilter: { and?: InputMaybe<EnvironmentFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<EnvironmentFilter[]>; permanentDeletionDate?: InputMaybe<DateFieldComparison>; slug?: InputMaybe<StringFieldComparison> }

Type declaration

EnvironmentInput

EnvironmentInput: { color?: InputMaybe<Scalars["String"]>; description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; hardenClientAccessEnabled?: InputMaybe<Scalars["Boolean"]>; provisionStatus?: InputMaybe<EnvironmentProvisionStatus> }

Input for updating an existing environment

Type declaration

  • Optional color?: InputMaybe<Scalars["String"]>

    The color used to distinguish this environment in the UI

  • Optional description?: InputMaybe<Scalars["String"]>

    Optional description of the environment

  • Optional displayName?: InputMaybe<Scalars["String"]>

    The name of the environment that will be displayed in the UI

  • Optional hardenClientAccessEnabled?: InputMaybe<Scalars["Boolean"]>

    Whether client-side security hardening is enabled for this environment

  • Optional provisionStatus?: InputMaybe<EnvironmentProvisionStatus>

    The current provisioning status of the environment

EnvironmentMergeConfigurationInput

EnvironmentMergeConfigurationInput: { includeCoupons?: InputMaybe<Scalars["Boolean"]> }

Configuration options for customizing an environment merge or comparison process

Type declaration

  • Optional includeCoupons?: InputMaybe<Scalars["Boolean"]>

    Whether to include coupons in the merge or comparison. Defaults to true if not specified

EnvironmentSort

EnvironmentSort: { direction: SortDirection; field: EnvironmentSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

EstimateSubscription

EstimateSubscription: { addons?: SubscriptionEstimationAddon[]; billableFeatures?: BillableFeature[]; billingCountryCode?: string; billingInformation?: SubscriptionBillingInfo; billingPeriod?: BillingPeriod; customerId: string; payingCustomerId?: string; planId: string; promotionCode?: string; resourceId?: string; skipTrial?: boolean; startDate?: Date; unitQuantity?: number }

Type declaration

  • Optional addons?: SubscriptionEstimationAddon[]
  • Optional billableFeatures?: BillableFeature[]
  • Optional billingCountryCode?: string
  • Optional billingInformation?: SubscriptionBillingInfo
  • Optional billingPeriod?: BillingPeriod
  • customerId: string
  • Optional payingCustomerId?: string
  • planId: string
  • Optional promotionCode?: string
  • Optional resourceId?: string
  • Optional skipTrial?: boolean
  • Optional startDate?: Date
  • Optional unitQuantity?: number

EstimateSubscriptionInput

EstimateSubscriptionInput: { addons?: InputMaybe<SubscriptionAddonInput[]>; appliedCoupon?: InputMaybe<SubscriptionCouponInput>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; billingCountryCode?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<SubscriptionBillingInfo>; billingPeriod?: InputMaybe<BillingPeriod>; charges?: InputMaybe<ChargeInput[]>; customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; payingCustomerId?: InputMaybe<Scalars["String"]>; planId: Scalars["String"]; priceUnitAmount?: InputMaybe<Scalars["Float"]>; promotionCode?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]>; skipTrial?: InputMaybe<Scalars["Boolean"]>; startDate?: InputMaybe<Scalars["DateTime"]>; trialOverrideConfiguration?: InputMaybe<TrialOverrideConfigurationInput>; unitQuantity?: InputMaybe<Scalars["Float"]> }

Type declaration

EstimateSubscriptionMutation

EstimateSubscriptionMutation: { __typename?: "Mutation"; estimateSubscription: { __typename?: "SubscriptionPreview" } & SubscriptionPreviewFragment }

Type declaration

EstimateSubscriptionMutationVariables

EstimateSubscriptionMutationVariables: Exact<{ input: EstimateSubscriptionInput }>

EstimateSubscriptionUpdate

EstimateSubscriptionUpdate: { addons?: SubscriptionEstimationAddon[]; billableFeatures?: BillableFeature[]; promotionCode?: string; subscriptionId: string; unitQuantity?: number }

Type declaration

EstimateSubscriptionUpdateInput

EstimateSubscriptionUpdateInput: { addons?: InputMaybe<SubscriptionAddonInput[]>; appliedCoupon?: InputMaybe<SubscriptionCouponInput>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; charges?: InputMaybe<ChargeInput[]>; environmentId?: InputMaybe<Scalars["UUID"]>; promotionCode?: InputMaybe<Scalars["String"]>; subscriptionId: Scalars["String"]; unitQuantity?: InputMaybe<Scalars["Float"]> }

Type declaration

EstimateSubscriptionUpdateMutation

EstimateSubscriptionUpdateMutation: { __typename?: "Mutation"; estimateSubscriptionUpdate: { __typename?: "SubscriptionPreview" } & SubscriptionPreviewFragment }

Type declaration

EstimateSubscriptionUpdateMutationVariables

EstimateSubscriptionUpdateMutationVariables: Exact<{ input: EstimateSubscriptionUpdateInput }>

EventLogCreatedAtFilterComparison

EventLogCreatedAtFilterComparison: { gte?: InputMaybe<Scalars["DateTime"]>; lte?: InputMaybe<Scalars["DateTime"]> }

Type declaration

EventLogEntityIdFilterComparison

EventLogEntityIdFilterComparison: { eq?: InputMaybe<Scalars["String"]>; in?: InputMaybe<Scalars["String"][]>; like?: InputMaybe<Scalars["String"]> }

Type declaration

EventLogEntityTypeFilterComparison

EventLogEntityTypeFilterComparison: { eq?: InputMaybe<EventEntityType>; in?: InputMaybe<EventEntityType[]> }

Type declaration

EventLogEnvironmentIdFilterComparison

EventLogEnvironmentIdFilterComparison: { eq?: InputMaybe<Scalars["UUID"]> }

Type declaration

EventLogEventLogTypeFilterComparison

EventLogEventLogTypeFilterComparison: { eq?: InputMaybe<EventLogType>; in?: InputMaybe<EventLogType[]>; neq?: InputMaybe<EventLogType>; notIn?: InputMaybe<EventLogType[]> }

Type declaration

EventLogFilter

EventLogFilter: { and?: InputMaybe<EventLogFilter[]>; createdAt?: InputMaybe<EventLogCreatedAtFilterComparison>; entityId?: InputMaybe<EventLogEntityIdFilterComparison>; entityType?: InputMaybe<EventLogEntityTypeFilterComparison>; environmentId?: InputMaybe<EventLogEnvironmentIdFilterComparison>; eventLogType?: InputMaybe<EventLogEventLogTypeFilterComparison>; id?: InputMaybe<EventLogIdFilterComparison>; or?: InputMaybe<EventLogFilter[]>; parentEntityId?: InputMaybe<EventLogParentEntityIdFilterComparison>; traceId?: InputMaybe<EventLogTraceIdFilterComparison> }

Type declaration

EventLogIdFilterComparison

EventLogIdFilterComparison: { eq?: InputMaybe<Scalars["String"]> }

Type declaration

EventLogParentEntityIdFilterComparison

EventLogParentEntityIdFilterComparison: { eq?: InputMaybe<Scalars["String"]>; in?: InputMaybe<Scalars["String"][]>; like?: InputMaybe<Scalars["String"]> }

Type declaration

EventLogSort

EventLogSort: { direction: SortDirection; field: EventLogSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

EventLogTraceIdFilterComparison

EventLogTraceIdFilterComparison: { eq?: InputMaybe<Scalars["String"]> }

Type declaration

EventsFieldsInput

EventsFieldsInput: { customerId?: InputMaybe<Scalars["String"]>; environmentId: Scalars["UUID"]; featureId?: InputMaybe<Scalars["String"]>; filters?: InputMaybe<MeterFilterDefinitionInput[]>; meterId?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]>; uniqueValuesLimit?: InputMaybe<Scalars["Float"]> }

Input parameters for retrieving events fields

Type declaration

Exact

Exact<T>: { [ K in keyof T]: T[K] }

Type parameters

  • T: {}

ExperimentFilter

ExperimentFilter: { and?: InputMaybe<ExperimentFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; customers?: InputMaybe<ExperimentFilterCustomerFilter>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<ExperimentFilter[]>; productId?: InputMaybe<StringFieldComparison>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<ExperimentStatusFilterComparison> }

Type declaration

ExperimentFilterCustomerFilter

ExperimentFilterCustomerFilter: { and?: InputMaybe<ExperimentFilterCustomerFilter[]>; awsMarketplaceCustomerId?: InputMaybe<StringFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmHubspotCompanyId?: InputMaybe<StringFieldComparison>; crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; customerId?: InputMaybe<StringFieldComparison>; deletedAt?: InputMaybe<DateFieldComparison>; email?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<ExperimentFilterCustomerFilter[]>; refId?: InputMaybe<StringFieldComparison>; salesforceId?: InputMaybe<StringFieldComparison>; searchQuery?: InputMaybe<CustomerSearchQueryFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

ExperimentInfo

ExperimentInfo: { groupName: string; groupType?: ExperimentGroupType | null; id: string; name: string }

Type declaration

ExperimentSort

ExperimentSort: { direction: SortDirection; field: ExperimentSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

ExperimentStatsQuery

ExperimentStatsQuery: { environmentId?: InputMaybe<Scalars["UUID"]>; experimentRefId: Scalars["String"] }

Query parameters for retrieving experiment statistics

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • experimentRefId: Scalars["String"]

    The unique identifier for the experiment

ExperimentStatusFilterComparison

ExperimentStatusFilterComparison: { eq?: InputMaybe<ExperimentStatus>; gt?: InputMaybe<ExperimentStatus>; gte?: InputMaybe<ExperimentStatus>; iLike?: InputMaybe<ExperimentStatus>; in?: InputMaybe<ExperimentStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<ExperimentStatus>; lt?: InputMaybe<ExperimentStatus>; lte?: InputMaybe<ExperimentStatus>; neq?: InputMaybe<ExperimentStatus>; notILike?: InputMaybe<ExperimentStatus>; notIn?: InputMaybe<ExperimentStatus[]>; notLike?: InputMaybe<ExperimentStatus> }

Type declaration

FeatureAssociatedLatestPackages

FeatureAssociatedLatestPackages: { environmentId: Scalars["UUID"]; featureId: Scalars["String"] }

Input for getting the associated latest packages for a feature

Type declaration

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • featureId: Scalars["String"]

    The ID of the feature

FeatureFilter

FeatureFilter: { and?: InputMaybe<FeatureFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; featureStatus?: InputMaybe<FeatureStatusFilterComparison>; featureType?: InputMaybe<FeatureTypeFilterComparison>; id?: InputMaybe<UuidFilterComparison>; meterType?: InputMaybe<MeterTypeFilterComparison>; or?: InputMaybe<FeatureFilter[]>; refId?: InputMaybe<StringFieldComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

FeatureFragment

FeatureFragment: { __typename: "EntitlementFeature"; description?: string | null; displayName: string; featureType: FeatureType; featureUnits?: string | null; featureUnitsPlural?: string | null; meterType?: MeterType | null; refId: string; unitTransformation?: { __typename?: "UnitTransformation"; divide: number; round: UnitTransformationRound } | null }

Type declaration

  • __typename: "EntitlementFeature"
  • Optional description?: string | null
  • displayName: string
  • featureType: FeatureType
  • Optional featureUnits?: string | null
  • Optional featureUnitsPlural?: string | null
  • Optional meterType?: MeterType | null
  • refId: string
  • Optional unitTransformation?: { __typename?: "UnitTransformation"; divide: number; round: UnitTransformationRound } | null

FeatureGroupAssociatedLatestPackagesInput

FeatureGroupAssociatedLatestPackagesInput: { environmentId: Scalars["UUID"]; featureGroupId: Scalars["String"] }

Input for getting associated latest packages of a feature group

Type declaration

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • featureGroupId: Scalars["String"]

    The feature group id

FeatureGroupFilter

FeatureGroupFilter: { and?: InputMaybe<FeatureGroupFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; featureGroupId?: InputMaybe<StringFieldComparison>; id?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<FeatureGroupFilter[]>; status?: InputMaybe<FeatureGroupStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

FeatureGroupSort

FeatureGroupSort: { direction: SortDirection; field: FeatureGroupSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

FeatureGroupStatusFilterComparison

FeatureGroupStatusFilterComparison: { eq?: InputMaybe<FeatureGroupStatus>; gt?: InputMaybe<FeatureGroupStatus>; gte?: InputMaybe<FeatureGroupStatus>; iLike?: InputMaybe<FeatureGroupStatus>; in?: InputMaybe<FeatureGroupStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<FeatureGroupStatus>; lt?: InputMaybe<FeatureGroupStatus>; lte?: InputMaybe<FeatureGroupStatus>; neq?: InputMaybe<FeatureGroupStatus>; notILike?: InputMaybe<FeatureGroupStatus>; notIn?: InputMaybe<FeatureGroupStatus[]>; notLike?: InputMaybe<FeatureGroupStatus> }

Type declaration

FeatureInput

FeatureInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; description?: InputMaybe<Scalars["String"]>; displayName: Scalars["String"]; enumConfiguration?: InputMaybe<EnumConfigurationEntityInput[]>; environmentId: Scalars["UUID"]; featureStatus?: InputMaybe<FeatureStatus>; featureType: FeatureType; featureUnits?: InputMaybe<Scalars["String"]>; featureUnitsPlural?: InputMaybe<Scalars["String"]>; meter?: InputMaybe<CreateMeter>; meterType?: InputMaybe<MeterType>; refId: Scalars["String"]; unitTransformation?: InputMaybe<UnitTransformationInput> }

Input for creating a feature

Type declaration

FeatureSort

FeatureSort: { direction: SortDirection; field: FeatureSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

FeatureStatusFilterComparison

FeatureStatusFilterComparison: { eq?: InputMaybe<FeatureStatus>; gt?: InputMaybe<FeatureStatus>; gte?: InputMaybe<FeatureStatus>; iLike?: InputMaybe<FeatureStatus>; in?: InputMaybe<FeatureStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<FeatureStatus>; lt?: InputMaybe<FeatureStatus>; lte?: InputMaybe<FeatureStatus>; neq?: InputMaybe<FeatureStatus>; notILike?: InputMaybe<FeatureStatus>; notIn?: InputMaybe<FeatureStatus[]>; notLike?: InputMaybe<FeatureStatus> }

Type declaration

FeatureTypeFilterComparison

FeatureTypeFilterComparison: { eq?: InputMaybe<FeatureType>; gt?: InputMaybe<FeatureType>; gte?: InputMaybe<FeatureType>; iLike?: InputMaybe<FeatureType>; in?: InputMaybe<FeatureType[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<FeatureType>; lt?: InputMaybe<FeatureType>; lte?: InputMaybe<FeatureType>; neq?: InputMaybe<FeatureType>; notILike?: InputMaybe<FeatureType>; notIn?: InputMaybe<FeatureType[]>; notLike?: InputMaybe<FeatureType> }

Type declaration

FetchEntitlementQuery

FetchEntitlementQuery: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["String"]>; featureId: Scalars["String"]; options?: InputMaybe<EntitlementOptions>; resourceId?: InputMaybe<Scalars["String"]> }

Query for fetching a single entitlement for a specific feature and customer.

Type declaration

  • customerId: Scalars["String"]

    Identifier of the customer.

  • Optional environmentId?: InputMaybe<Scalars["String"]>

    The environment identifier used to resolve the entitlement context.

  • featureId: Scalars["String"]

    The internal ID of the feature linked to this entitlement.

  • Optional options?: InputMaybe<EntitlementOptions>

    Options for configuring how an entitlement is tracked or applied.

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The scoped resource Identifier.

FetchEntitlementsQuery

FetchEntitlementsQuery: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]> }

Query for retrieving all entitlements for a customer in a specific environment.

Type declaration

  • customerId: Scalars["String"]

    Identifier of the customer.

  • Optional environmentId?: InputMaybe<Scalars["String"]>

    The environment context for entitlement resolution.

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The scoped resource Identifier.

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

FontVariantFragment

FontVariantFragment: { __typename?: "FontVariant"; fontSize?: number | null; fontWeight?: FontWeight | null }

Type declaration

  • Optional __typename?: "FontVariant"
  • Optional fontSize?: number | null
  • Optional fontWeight?: FontWeight | null

FontVariantInput

FontVariantInput: { fontSize?: InputMaybe<Scalars["Float"]>; fontWeight?: InputMaybe<FontWeight> }

Input for defining font style for a text variant.

Type declaration

GetActiveSubscriptions

GetActiveSubscriptions: { resourceId?: string | string[] }

Type declaration

  • Optional resourceId?: string | string[]

GetActiveSubscriptionsInput

GetActiveSubscriptionsInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; resourceId?: InputMaybe<Scalars["String"]>; resourceIds?: InputMaybe<Scalars["String"][]> }

Type declaration

GetActiveSubscriptionsListQuery

GetActiveSubscriptionsListQuery: { __typename?: "Query"; getActiveSubscriptions: ({ __typename?: "CustomerSubscription" } & SlimSubscriptionFragmentV2Fragment)[] }

Type declaration

GetActiveSubscriptionsListQueryVariables

GetActiveSubscriptionsListQueryVariables: Exact<{ input: GetActiveSubscriptionsInput }>

GetActiveSubscriptionsQuery

GetActiveSubscriptionsQuery: { __typename?: "Query"; getActiveSubscriptions: ({ __typename?: "CustomerSubscription" } & SubscriptionFragment)[] }

Type declaration

  • Optional __typename?: "Query"
  • getActiveSubscriptions: ({ __typename?: "CustomerSubscription" } & SubscriptionFragment)[]

GetActiveSubscriptionsQueryVariables

GetActiveSubscriptionsQueryVariables: Exact<{ input: GetActiveSubscriptionsInput }>

GetAuth0ApplicationsInput

GetAuth0ApplicationsInput: { clientDomain: Scalars["String"]; clientId: Scalars["String"]; clientSecret: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]> }

Input configuration for retrieving Auth0 applications

Type declaration

  • clientDomain: Scalars["String"]

    Domain of the Auth0 client

  • clientId: Scalars["String"]

    ID of the Auth0 client

  • clientSecret: Scalars["String"]

    Secret of the Auth0 client

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

GetAutoRechargeSettingsInput

GetAutoRechargeSettingsInput: { currencyId: Scalars["String"]; customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["String"]> }

Input for getting auto-recharge settings

Type declaration

  • currencyId: Scalars["String"]

    Currency ID

  • customerId: Scalars["String"]

    Customer ID (refId)

  • Optional environmentId?: InputMaybe<Scalars["String"]>

    Environment ID

GetAutomaticRechargeConfigurationInput

GetAutomaticRechargeConfigurationInput: GetAutoRechargeSettingsInput

GetAutomaticRechargeConfigurationQuery

GetAutomaticRechargeConfigurationQuery: { __typename?: "Query"; getAutoRechargeSettings: { __typename?: "AutoRechargeSettingsDTO" } & AutoRechargeSettingsFragment }

Type declaration

GetAutomaticRechargeConfigurationQueryVariables

GetAutomaticRechargeConfigurationQueryVariables: Exact<{ input: GetAutoRechargeSettingsInput }>

GetBooleanEntitlement

GetBooleanEntitlement: { featureId: string; options?: BooleanEntitlementOptions; resourceId?: string }

Type declaration

GetCheckoutState

GetCheckoutState: { billingCountryCode?: string; planId: string; resourceId?: string | null }

Type declaration

  • Optional billingCountryCode?: string
  • planId: string
  • Optional resourceId?: string | null

GetCheckoutStateQuery

GetCheckoutStateQuery: { __typename?: "Query"; checkoutState: { __typename?: "CheckoutState" } & CheckoutStateFragment }

Type declaration

GetCheckoutStateQueryVariables

GetCheckoutStateQueryVariables: Exact<{ input: CheckoutStateInput }>

GetCheckoutStateResults

GetCheckoutStateResults: { activeSubscription?: Subscription | null; billingIntegration: CheckoutBillingIntegration; configuration?: CheckoutConfiguration | null; customer: Customer; plan: CheckoutStatePlan; resource: CustomerResource | null; setupSecret: string }

Type declaration

GetCouponsQuery

GetCouponsQuery: { __typename?: "Query"; coupons: { __typename?: "CouponConnection"; edges: { __typename?: "CouponEdge"; node: { __typename?: "Coupon" } & CouponFragment }[] } }

Type declaration

  • Optional __typename?: "Query"
  • coupons: { __typename?: "CouponConnection"; edges: { __typename?: "CouponEdge"; node: { __typename?: "Coupon" } & CouponFragment }[] }
    • Optional __typename?: "CouponConnection"
    • edges: { __typename?: "CouponEdge"; node: { __typename?: "Coupon" } & CouponFragment }[]

GetCouponsQueryVariables

GetCouponsQueryVariables: Exact<{}>

GetCreditBalanceInput

GetCreditBalanceInput: Omit<CreditBalanceSummaryInput, "customerId" | "resourceId">

GetCreditBalanceQuery

GetCreditBalanceQuery: { __typename?: "Query"; creditBalanceSummary: { __typename?: "CreditBalanceSummary" } & CreditsBalanceSummaryFragment }

Type declaration

GetCreditBalanceQueryVariables

GetCreditBalanceQueryVariables: Exact<{ input: CreditBalanceSummaryInput }>

GetCreditGrantsInput

GetCreditGrantsInput: Omit<GetCreditGrantsInputGenerated, "customerId" | "resourceId">

GetCreditGrantsQuery

GetCreditGrantsQuery: { __typename?: "Query"; creditGrants: { __typename?: "CreditGrantConnection"; edges: { __typename?: "CreditGrantEdge"; node: { __typename?: "CreditGrant" } & CreditGrantFragment }[]; pageInfo: { __typename?: "PageInfo" } & PageInfoFragment; totalCount: number } }

Type declaration

  • Optional __typename?: "Query"
  • creditGrants: { __typename?: "CreditGrantConnection"; edges: { __typename?: "CreditGrantEdge"; node: { __typename?: "CreditGrant" } & CreditGrantFragment }[]; pageInfo: { __typename?: "PageInfo" } & PageInfoFragment; totalCount: number }
    • Optional __typename?: "CreditGrantConnection"
    • edges: { __typename?: "CreditGrantEdge"; node: { __typename?: "CreditGrant" } & CreditGrantFragment }[]
    • pageInfo: { __typename?: "PageInfo" } & PageInfoFragment
    • totalCount: number

GetCreditGrantsQueryVariables

GetCreditGrantsQueryVariables: Exact<{ input: GetCreditGrantsInput }>

GetCreditGrantsResult

GetCreditGrantsResult: PaginatedResult<CreditGrantFragment>

GetCreditLedgerInput

GetCreditLedgerInput: Omit<CreditLedgerInput, "customerId" | "resourceId">

GetCreditLedgerQuery

GetCreditLedgerQuery: { __typename?: "Query"; creditsLedger: { __typename?: "CreditLedgerConnection"; edges: { __typename?: "CreditLedgerEdge"; cursor: string; node: { __typename?: "CreditLedgerEvent" } & CreditLedgerFragment }[]; pageInfo: { __typename?: "PageInfo" } & PageInfoFragment; totalCount: number } }

Type declaration

  • Optional __typename?: "Query"
  • creditsLedger: { __typename?: "CreditLedgerConnection"; edges: { __typename?: "CreditLedgerEdge"; cursor: string; node: { __typename?: "CreditLedgerEvent" } & CreditLedgerFragment }[]; pageInfo: { __typename?: "PageInfo" } & PageInfoFragment; totalCount: number }
    • Optional __typename?: "CreditLedgerConnection"
    • edges: { __typename?: "CreditLedgerEdge"; cursor: string; node: { __typename?: "CreditLedgerEvent" } & CreditLedgerFragment }[]
    • pageInfo: { __typename?: "PageInfo" } & PageInfoFragment
    • totalCount: number

GetCreditLedgerQueryVariables

GetCreditLedgerQueryVariables: Exact<{ input: CreditLedgerInput }>

GetCreditLedgerResult

GetCreditLedgerResult: PaginatedResult<CreditLedgerFragment>

GetCreditUsageInput

GetCreditUsageInput: Omit<CreditUsageInput, "customerId" | "resourceId">

GetCreditUsageQuery

GetCreditUsageQuery: { __typename?: "Query"; creditUsage: { __typename?: "CreditUsage" } & CreditUsageFragment }

Type declaration

GetCreditUsageQueryVariables

GetCreditUsageQueryVariables: Exact<{ input: CreditUsageInput }>

GetCustomerByIdQuery

GetCustomerByIdQuery: { __typename?: "Query"; getCustomerByRefId?: ({ __typename?: "Customer" } & CustomerWithSubscriptionsFragment) | null }

Type declaration

GetCustomerByIdQueryVariables

GetCustomerByIdQueryVariables: Exact<{ input: GetCustomerByRefIdInput }>

GetCustomerByRefIdInput

GetCustomerByRefIdInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]> }

Get a customer by slug

Type declaration

  • customerId: Scalars["String"]

    Customer slug

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

GetCustomerPortal

GetCustomerPortal: { productId?: string; resourceId?: string }

Type declaration

  • Optional productId?: string
  • Optional resourceId?: string

GetCustomerPortalByRefIdQuery

GetCustomerPortalByRefIdQuery: { __typename?: "Query"; customerPortal: { __typename?: "CustomerPortal" } & CustomerPortalFragment }

Type declaration

GetCustomerPortalByRefIdQueryVariables

GetCustomerPortalByRefIdQueryVariables: Exact<{ input: CustomerPortalInput }>

GetCustomerStatisticsQuery

GetCustomerStatisticsQuery: { __typename?: "Query"; getCustomerByRefId?: ({ __typename?: "Customer" } & CustomerStatisticsFragment) | null }

Type declaration

GetCustomerStatisticsQueryVariables

GetCustomerStatisticsQueryVariables: Exact<{ input: GetCustomerByRefIdInput }>

GetEntitlementQuery

GetEntitlementQuery: { __typename?: "Query"; entitlement: { __typename?: "Entitlement" } & EntitlementFragment }

Type declaration

GetEntitlementQueryVariables

GetEntitlementQueryVariables: Exact<{ query: FetchEntitlementQuery }>

GetEntitlementsQuery

GetEntitlementsQuery: { __typename?: "Query"; entitlements: ({ __typename?: "Entitlement" } & EntitlementFragment)[] }

Type declaration

  • Optional __typename?: "Query"
  • entitlements: ({ __typename?: "Entitlement" } & EntitlementFragment)[]

GetEntitlementsQueryVariables

GetEntitlementsQueryVariables: Exact<{ query: FetchEntitlementsQuery }>

GetEntitlementsStateQuery

GetEntitlementsStateQuery: { __typename?: "Query"; entitlementsState: { __typename: "EntitlementsState"; accessDeniedReason?: EntitlementsStateAccessDeniedReason | null; entitlements: ({ __typename?: "Entitlement" } & EntitlementFragment)[] } }

Type declaration

GetEntitlementsStateQueryVariables

GetEntitlementsStateQueryVariables: Exact<{ query: FetchEntitlementsQuery }>

GetEnumEntitlement

GetEnumEntitlement: { featureId: string; options?: EnumEntitlementOptions; resourceId?: string }

Type declaration

GetMeteredEntitlement

GetMeteredEntitlement: { featureId: string; options?: MeteredEntitlementOptions; resourceId?: string }

Type declaration

GetMockPaywallQuery

GetMockPaywallQuery: { __typename?: "Query"; mockPaywall: { __typename?: "MockPaywall"; configuration?: ({ __typename?: "PaywallConfiguration" } & PaywallConfigurationFragment) | null; plans: ({ __typename?: "PaywallPlan" } & MockPaywallPlanFragment)[] } }

Type declaration

GetMockPaywallQueryVariables

GetMockPaywallQueryVariables: Exact<{ input: GetPaywallInput }>

GetNumericEntitlement

GetNumericEntitlement: { featureId: string; options?: NumericEntitlementOptions; resourceId?: string }

Type declaration

GetOfferInput

GetOfferInput: { environmentId?: InputMaybe<Scalars["UUID"]>; offerId: Scalars["String"]; version?: InputMaybe<Scalars["Float"]> }

Get offer input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • offerId: Scalars["String"]

    The unique identifier for the entity

  • Optional version?: InputMaybe<Scalars["Float"]>

    Offer version

GetPackageByRefIdInput

GetPackageByRefIdInput: { environmentId: Scalars["String"]; refId: Scalars["String"]; versionNumber?: InputMaybe<Scalars["Float"]> }

Get Package By Ref Id Input

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • refId: Scalars["String"]

    The unique identifier for the entity

  • Optional versionNumber?: InputMaybe<Scalars["Float"]>

    The version number of the package

GetPackageGroup

GetPackageGroup: { environmentId: Scalars["String"]; packageGroupId: Scalars["String"]; versionNumber?: InputMaybe<Scalars["Float"]> }

The input type for getting a package group

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • packageGroupId: Scalars["String"]

    The id of the package group to filter by

  • Optional versionNumber?: InputMaybe<Scalars["Float"]>

    The version number of the package group to filter by

GetPaywall

GetPaywall: { billingCountryCode?: string; context?: WidgetType; includeHiddenPlans?: boolean; productId?: string; resourceId?: string }

Type declaration

  • Optional billingCountryCode?: string
  • Optional context?: WidgetType
  • Optional includeHiddenPlans?: boolean
  • Optional productId?: string
  • Optional resourceId?: string

GetPaywallInput

GetPaywallInput: { billingCountryCode?: InputMaybe<Scalars["String"]>; context?: InputMaybe<WidgetType>; customerId?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; fetchAllCountriesPrices?: InputMaybe<Scalars["Boolean"]>; includeHiddenPlans?: InputMaybe<Scalars["Boolean"]>; offerId?: InputMaybe<Scalars["String"]>; productId?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]> }

Input for fetching the paywall

Type declaration

  • Optional billingCountryCode?: InputMaybe<Scalars["String"]>

    The country code for billing, e.g. US

  • Optional context?: InputMaybe<WidgetType>

    Context for the paywall, e.g. "checkout" or "subscription"

  • Optional customerId?: InputMaybe<Scalars["String"]>

    The customer ID for whom the paywall is being fetched

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional fetchAllCountriesPrices?: InputMaybe<Scalars["Boolean"]>

    Whether to fetch prices for all countries or just the specified billing country

  • Optional includeHiddenPlans?: InputMaybe<Scalars["Boolean"]>

    Whether to include hidden plans in the paywall

  • Optional offerId?: InputMaybe<Scalars["String"]>

    The offer id for which the paywall is being fetched

  • Optional productId?: InputMaybe<Scalars["String"]>

    The product ID for which the paywall is being fetched

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The resource ID for which the paywall is being fetched

GetPaywallQuery

GetPaywallQuery: { __typename?: "Query"; paywall: { __typename?: "Paywall" } & PaywallFragment }

Type declaration

  • Optional __typename?: "Query"
  • paywall: { __typename?: "Paywall" } & PaywallFragment

GetPaywallQueryVariables

GetPaywallQueryVariables: Exact<{ input: GetPaywallInput }>

GetProductsQuery

GetProductsQuery: { __typename?: "Query"; products: { __typename?: "ProductConnection"; edges: { __typename?: "ProductEdge"; node: { __typename?: "Product" } & ProductFragment }[] } }

Type declaration

  • Optional __typename?: "Query"
  • products: { __typename?: "ProductConnection"; edges: { __typename?: "ProductEdge"; node: { __typename?: "Product" } & ProductFragment }[] }
    • Optional __typename?: "ProductConnection"
    • edges: { __typename?: "ProductEdge"; node: { __typename?: "Product" } & ProductFragment }[]

GetProductsQueryVariables

GetProductsQueryVariables: Exact<{}>

GetSdkConfigurationQuery

GetSdkConfigurationQuery: { __typename?: "Query"; sdkConfiguration?: { __typename?: "SdkConfiguration"; isWidgetWatermarkEnabled?: boolean | null; sentryDsn?: string | null; showWatermark?: boolean | null } | null }

Type declaration

  • Optional __typename?: "Query"
  • Optional sdkConfiguration?: { __typename?: "SdkConfiguration"; isWidgetWatermarkEnabled?: boolean | null; sentryDsn?: string | null; showWatermark?: boolean | null } | null

GetSdkConfigurationQueryVariables

GetSdkConfigurationQueryVariables: Exact<{}>

GetSubscription

GetSubscription: { subscriptionId: string }

Type declaration

  • subscriptionId: string

GetSubscriptionInput

GetSubscriptionInput: { environmentId?: InputMaybe<Scalars["UUID"]>; subscriptionId: Scalars["String"] }

Get subscription input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The environment ID the subscription belongs to

  • subscriptionId: Scalars["String"]

    The subscription ID to retrieve

GetSubscriptionQuery

GetSubscriptionQuery: { __typename?: "Query"; getSubscription: { __typename?: "CustomerSubscription" } & SubscriptionFragment }

Type declaration

  • Optional __typename?: "Query"
  • getSubscription: { __typename?: "CustomerSubscription" } & SubscriptionFragment

GetSubscriptionQueryVariables

GetSubscriptionQueryVariables: Exact<{ input: GetSubscriptionInput }>

GetSubscriptionsParams

GetSubscriptionsParams: { customerId?: string; pagination?: { endingBefore?: string; limit?: number; startingAfter?: string }; productId?: string | string[]; resourceId?: string | string[]; status?: SubscriptionStatus | SubscriptionStatus[] }

Type declaration

  • Optional customerId?: string
  • Optional pagination?: { endingBefore?: string; limit?: number; startingAfter?: string }
    • Optional endingBefore?: string
    • Optional limit?: number
    • Optional startingAfter?: string
  • Optional productId?: string | string[]
  • Optional resourceId?: string | string[]
  • Optional status?: SubscriptionStatus | SubscriptionStatus[]

GetSubscriptionsQuery

GetSubscriptionsQuery: { __typename?: "Query"; subscriptions: { __typename?: "SubscriptionQueryConnection"; edges: { __typename?: "SubscriptionQueryEdge"; node: { __typename?: "SubscriptionQuery" } & SubscriptionQueryFragment }[]; pageInfo: { __typename?: "PageInfo" } & PageInfoFragment } }

Type declaration

  • Optional __typename?: "Query"
  • subscriptions: { __typename?: "SubscriptionQueryConnection"; edges: { __typename?: "SubscriptionQueryEdge"; node: { __typename?: "SubscriptionQuery" } & SubscriptionQueryFragment }[]; pageInfo: { __typename?: "PageInfo" } & PageInfoFragment }
    • Optional __typename?: "SubscriptionQueryConnection"
    • edges: { __typename?: "SubscriptionQueryEdge"; node: { __typename?: "SubscriptionQuery" } & SubscriptionQueryFragment }[]
    • pageInfo: { __typename?: "PageInfo" } & PageInfoFragment

GetSubscriptionsQueryVariables

GetSubscriptionsQueryVariables: Exact<{ filter?: InputMaybe<SubscriptionQueryFilter>; paging?: InputMaybe<CursorPaging>; sorting?: InputMaybe<SubscriptionQuerySort[] | SubscriptionQuerySort> }>

GetSubscriptionsResult

GetSubscriptionsResult: PaginatedResult<SubscriptionQueryFragment>

GetUsageHistoryQuery

GetUsageHistoryQuery: { __typename?: "Query"; usageHistory: { __typename?: "UsageHistory" } & UsageHistoryFragment }

Type declaration

GetUsageHistoryQueryVariables

GetUsageHistoryQueryVariables: Exact<{ usageHistoryInput: UsageHistoryInput }>

GetUsageHistoryV2Query

GetUsageHistoryV2Query: { __typename?: "Query"; usageHistoryV2: { __typename?: "UsageHistoryV2" } & UsageHistoryV2Fragment }

Type declaration

GetUsageHistoryV2QueryVariables

GetUsageHistoryV2QueryVariables: Exact<{ input: UsageHistoryV2Input }>

GetWidgetConfigurationInput

GetWidgetConfigurationInput: { environmentId?: InputMaybe<Scalars["UUID"]> }

Input object used to retrieve current widget configuration for the environment.

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

GetWorkflowTriggersInput

GetWorkflowTriggersInput: { environmentId?: InputMaybe<Scalars["UUID"]>; triggerId?: InputMaybe<Scalars["String"]>; workflowTriggerId?: InputMaybe<Scalars["String"]> }

Get workflow triggers input

Type declaration

GrantCreditsMutation

GrantCreditsMutation: { __typename?: "Mutation"; createCreditGrant: { __typename?: "CreditGrant" } & CreditGrantFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • createCreditGrant: { __typename?: "CreditGrant" } & CreditGrantFragment

GrantCreditsMutationVariables

GrantCreditsMutationVariables: Exact<{ input: CreditGrantInput }>

GrantPromotionalEntitlementInput

GrantPromotionalEntitlementInput: { customEndDate?: InputMaybe<Scalars["DateTime"]>; enumValues?: InputMaybe<Scalars["String"][]>; featureId: Scalars["String"]; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; isVisible?: InputMaybe<Scalars["Boolean"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; period: PromotionalEntitlementPeriod; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Grant promotional entitlement input

Type declaration

GrantPromotionalEntitlementsGroupInput

GrantPromotionalEntitlementsGroupInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; featureGroupId: Scalars["String"]; promotionalEntitlements: GrantPromotionalEntitlementInput[] }

Grant promotional entitlements for a feature group input

Type declaration

  • customerId: Scalars["String"]

    The unique identifier of the entitlement customer

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureGroupId: Scalars["String"]

    Feature group ID to grant as promotional entitlement

  • promotionalEntitlements: GrantPromotionalEntitlementInput[]

    List of promotional entitlements for features in the group

GrantPromotionalEntitlementsGroupMutation

GrantPromotionalEntitlementsGroupMutation: { __typename?: "Mutation"; grantPromotionalEntitlementsGroup: ({ __typename?: "PromotionalEntitlement" } & PromotionalEntitlementFragment)[] }

Type declaration

GrantPromotionalEntitlementsGroupMutationVariables

GrantPromotionalEntitlementsGroupMutationVariables: Exact<{ input: GrantPromotionalEntitlementsGroupInput }>

GrantPromotionalEntitlementsInput

GrantPromotionalEntitlementsInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; promotionalEntitlements: GrantPromotionalEntitlementInput[] }

Grant multiple promotional entitlements input

Type declaration

GrantPromotionalEntitlementsMutation

GrantPromotionalEntitlementsMutation: { __typename?: "Mutation"; grantPromotionalEntitlements: ({ __typename?: "PromotionalEntitlement" } & PromotionalEntitlementFragment)[] }

Type declaration

GrantPromotionalEntitlementsMutationVariables

GrantPromotionalEntitlementsMutationVariables: Exact<{ input: GrantPromotionalEntitlementsInput }>

HookFilter

HookFilter: { and?: InputMaybe<HookFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; endpoint?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<HookFilter[]>; status?: InputMaybe<HookStatusFilterComparison> }

Type declaration

HookSort

HookSort: { direction: SortDirection; field: HookSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

HookStatusFilterComparison

HookStatusFilterComparison: { eq?: InputMaybe<HookStatus>; gt?: InputMaybe<HookStatus>; gte?: InputMaybe<HookStatus>; iLike?: InputMaybe<HookStatus>; in?: InputMaybe<HookStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<HookStatus>; lt?: InputMaybe<HookStatus>; lte?: InputMaybe<HookStatus>; neq?: InputMaybe<HookStatus>; notILike?: InputMaybe<HookStatus>; notIn?: InputMaybe<HookStatus[]>; notLike?: InputMaybe<HookStatus> }

Type declaration

HubspotCredentialsInput

HubspotCredentialsInput: { authorizationCode: Scalars["String"]; refreshToken?: InputMaybe<Scalars["String"]> }

Input configuration for HubSpot integration

Type declaration

  • authorizationCode: Scalars["String"]

    Authorization code for HubSpot

  • Optional refreshToken?: InputMaybe<Scalars["String"]>

    Refresh token for HubSpot

ImmediateSubscriptionPreviewInvoice

ImmediateSubscriptionPreviewInvoice: SubscriptionPreviewInvoice & { credits?: SubscriptionPreviewCredits; proration?: SubscriptionPreviewProration }

ImmediateSubscriptionPreviewInvoiceFragment

ImmediateSubscriptionPreviewInvoiceFragment: { __typename?: "ImmediateSubscriptionPreviewInvoice"; credits?: { __typename?: "SubscriptionPreviewCredits"; initial: { __typename?: "Money"; amount: number; currency: Currency }; remaining: { __typename?: "Money"; amount: number; currency: Currency }; used: { __typename?: "Money"; amount: number; currency: Currency } } | null; discount?: { __typename?: "Money"; amount: number; currency: Currency } | null; discountDetails?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; type: DiscountType; value: number } | null; proration?: { __typename?: "SubscriptionPreviewProrations"; credit: { __typename?: "Money"; amount: number; currency: Currency }; debit: { __typename?: "Money"; amount: number; currency: Currency }; hasProrations?: boolean | null; netAmount: { __typename?: "Money"; amount: number; currency: Currency }; prorationDate: any } | null; subTotal: { __typename?: "Money"; amount: number; currency: Currency }; tax?: { __typename?: "Money"; amount: number; currency: Currency } | null; taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null; total: { __typename?: "Money"; amount: number; currency: Currency }; totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency } }

Type declaration

  • Optional __typename?: "ImmediateSubscriptionPreviewInvoice"
  • Optional credits?: { __typename?: "SubscriptionPreviewCredits"; initial: { __typename?: "Money"; amount: number; currency: Currency }; remaining: { __typename?: "Money"; amount: number; currency: Currency }; used: { __typename?: "Money"; amount: number; currency: Currency } } | null
  • Optional discount?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional discountDetails?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; type: DiscountType; value: number } | null
  • Optional proration?: { __typename?: "SubscriptionPreviewProrations"; credit: { __typename?: "Money"; amount: number; currency: Currency }; debit: { __typename?: "Money"; amount: number; currency: Currency }; hasProrations?: boolean | null; netAmount: { __typename?: "Money"; amount: number; currency: Currency }; prorationDate: any } | null
  • subTotal: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • Optional tax?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null
  • total: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency

ImportCustomerBulkInput

ImportCustomerBulkInput: { customers: ImportCustomerInput[]; environmentId?: InputMaybe<Scalars["UUID"]> }

Input for importing a bulk of customers

Type declaration

ImportCustomerBulkMutation

ImportCustomerBulkMutation: { __typename?: "Mutation"; importCustomersBulk?: string | null }

Type declaration

  • Optional __typename?: "Mutation"
  • Optional importCustomersBulk?: string | null

ImportCustomerBulkMutationVariables

ImportCustomerBulkMutationVariables: Exact<{ input: ImportCustomerBulkInput }>

ImportCustomerInput

ImportCustomerInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; billingId?: InputMaybe<Scalars["String"]>; customerId?: InputMaybe<Scalars["String"]>; email?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; name?: InputMaybe<Scalars["String"]>; paymentMethodId?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; updatedAt?: InputMaybe<Scalars["DateTime"]> }

Input for importing a customer

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Additional metadata

  • Optional billingId?: InputMaybe<Scalars["String"]>

    Id in the billing provider

  • Optional customerId?: InputMaybe<Scalars["String"]>

    Customer slug

  • Optional email?: InputMaybe<Scalars["String"]>

    Customer email

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional name?: InputMaybe<Scalars["String"]>

    Customer name

  • Optional paymentMethodId?: InputMaybe<Scalars["String"]>

    Payment method Id in the billing provider

  • Optional refId?: InputMaybe<Scalars["String"]>

    Customer slug

  • Optional salesforceId?: InputMaybe<Scalars["String"]>

    The unique identifier for the customer in Salesforce integration

  • Optional updatedAt?: InputMaybe<Scalars["DateTime"]>

    Indicates the last update of the customer. In case there's already existing customer that was updated after that date, it will skip import this customer

ImportCustomerMutation

ImportCustomerMutation: { __typename?: "Mutation"; importCustomer: { __typename?: "Customer" } & SlimCustomerFragment }

Type declaration

ImportCustomerMutationVariables

ImportCustomerMutationVariables: Exact<{ input: ImportCustomerInput }>

ImportIntegrationCatalogInput

ImportIntegrationCatalogInput: { billingModel?: InputMaybe<BillingModel>; entitySelectionMode: EntitySelectionMode; environmentId: Scalars["String"]; featureUnitName?: InputMaybe<Scalars["String"]>; featureUnitPluralName?: InputMaybe<Scalars["String"]>; plansSelectionBlacklist?: InputMaybe<Scalars["String"][]>; plansSelectionWhitelist?: InputMaybe<Scalars["String"][]>; productId: Scalars["String"]; selectedAddonBillingIds: Scalars["String"][]; vendorIdentifier: VendorIdentifier }

Input parameters for importing product catalog from an integration

Type declaration

  • Optional billingModel?: InputMaybe<BillingModel>

    Billing model configuration for the imported product

  • entitySelectionMode: EntitySelectionMode

    Mode for selecting plans to import (blacklist or whitelist)

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • Optional featureUnitName?: InputMaybe<Scalars["String"]>

    Singular name for the feature unit

  • Optional featureUnitPluralName?: InputMaybe<Scalars["String"]>

    Plural name for the feature unit

  • Optional plansSelectionBlacklist?: InputMaybe<Scalars["String"][]>

    List of plan IDs to exclude when using blacklist mode

  • Optional plansSelectionWhitelist?: InputMaybe<Scalars["String"][]>

    List of plan IDs to include when using whitelist mode

  • productId: Scalars["String"]

    Product ID to import from the integration

  • selectedAddonBillingIds: Scalars["String"][]

    List of addon billing IDs to import

  • vendorIdentifier: VendorIdentifier

    The vendor identifier of integration

ImportIntegrationCustomersInput

ImportIntegrationCustomersInput: { customersSelectionBlacklist?: InputMaybe<Scalars["String"][]>; customersSelectionWhitelist?: InputMaybe<Scalars["String"][]>; entitySelectionMode: EntitySelectionMode; environmentId: Scalars["String"]; productId: Scalars["String"]; vendorIdentifier: VendorIdentifier }

Input parameters for importing customers from an integration

Type declaration

  • Optional customersSelectionBlacklist?: InputMaybe<Scalars["String"][]>

    List of customer IDs to exclude when using blacklist mode

  • Optional customersSelectionWhitelist?: InputMaybe<Scalars["String"][]>

    List of customer IDs to include when using whitelist mode

  • entitySelectionMode: EntitySelectionMode

    Mode for selecting customers to import (blacklist or whitelist)

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • productId: Scalars["String"]

    Product ID to import customers from

  • vendorIdentifier: VendorIdentifier

    The vendor identifier of integration

ImportIntegrationTaskFilter

ImportIntegrationTaskFilter: { and?: InputMaybe<ImportIntegrationTaskFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<StringFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<ImportIntegrationTaskFilter[]>; status?: InputMaybe<TaskStatusFilterComparison>; taskType?: InputMaybe<TaskTypeFilterComparison> }

Type declaration

ImportIntegrationTaskSort

ImportIntegrationTaskSort: { direction: SortDirection; field: ImportIntegrationTaskSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

ImportSubscriptionInput

ImportSubscriptionInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; addons?: InputMaybe<SubscriptionAddonInput[]>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; billingId?: InputMaybe<Scalars["String"]>; billingPeriod?: InputMaybe<BillingPeriod>; charges?: InputMaybe<ChargeInput[]>; customerId: Scalars["String"]; endDate?: InputMaybe<Scalars["DateTime"]>; planId: Scalars["String"]; resourceId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; startDate?: InputMaybe<Scalars["DateTime"]>; subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>; subscriptionId?: InputMaybe<Scalars["String"]>; unitQuantity?: InputMaybe<Scalars["Float"]>; updatedAt?: InputMaybe<Scalars["DateTime"]> }

Type declaration

ImportSubscriptionsBulkInput

ImportSubscriptionsBulkInput: { environmentId?: InputMaybe<Scalars["UUID"]>; subscriptions: ImportSubscriptionInput[] }

Type declaration

ImportSubscriptionsBulkMutation

ImportSubscriptionsBulkMutation: { __typename?: "Mutation"; importSubscriptionsBulk?: string | null }

Type declaration

  • Optional __typename?: "Mutation"
  • Optional importSubscriptionsBulk?: string | null

ImportSubscriptionsBulkMutationVariables

ImportSubscriptionsBulkMutationVariables: Exact<{ input: ImportSubscriptionsBulkInput }>

InitAddStripeCustomerPaymentMethodInput

InitAddStripeCustomerPaymentMethodInput: { customerRefId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; integrationId?: InputMaybe<Scalars["String"]> }

Input for initializing a payment method form for a customer

Type declaration

  • customerRefId: Scalars["String"]

    Customer slug

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional integrationId?: InputMaybe<Scalars["String"]>

    The billing integration to use for this payment method

InputMaybe

InputMaybe<T>: Maybe<T>

Type parameters

  • T

IntFieldComparison

IntFieldComparison: { between?: InputMaybe<IntFieldComparisonBetween>; eq?: InputMaybe<Scalars["Int"]>; gt?: InputMaybe<Scalars["Int"]>; gte?: InputMaybe<Scalars["Int"]>; in?: InputMaybe<Scalars["Int"][]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; lt?: InputMaybe<Scalars["Int"]>; lte?: InputMaybe<Scalars["Int"]>; neq?: InputMaybe<Scalars["Int"]>; notBetween?: InputMaybe<IntFieldComparisonBetween>; notIn?: InputMaybe<Scalars["Int"][]> }

Type declaration

IntFieldComparisonBetween

IntFieldComparisonBetween: { lower: Scalars["Int"]; upper: Scalars["Int"] }

Type declaration

IntegrationFilter

IntegrationFilter: { and?: InputMaybe<IntegrationFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<IntegrationFilter[]>; vendorIdentifier?: InputMaybe<VendorIdentifierFilterComparison>; vendorType?: InputMaybe<IntegrationVendorTypeFilterComparison> }

Type declaration

IntegrationSort

IntegrationSort: { direction: SortDirection; field: IntegrationSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

IntegrationVendorTypeFilterComparison

IntegrationVendorTypeFilterComparison: { eq?: InputMaybe<VendorType>; in?: InputMaybe<VendorType[]>; neq?: InputMaybe<VendorType>; notIn?: InputMaybe<VendorType[]> }

Type declaration

InviteMembersInput

InviteMembersInput: { accountRole?: InputMaybe<AccountAccessRole>; invites: Scalars["String"][]; nonProductionRole?: InputMaybe<EnvironmentAccessRole>; productionRole?: InputMaybe<EnvironmentAccessRole> }

Input for inviting members

Type declaration

LayoutConfigurationFragment

LayoutConfigurationFragment: { __typename?: "PaywallLayoutConfiguration"; alignment?: Alignment | null; planMargin?: number | null; planPadding?: number | null; planWidth?: number | null }

Type declaration

  • Optional __typename?: "PaywallLayoutConfiguration"
  • Optional alignment?: Alignment | null
  • Optional planMargin?: number | null
  • Optional planPadding?: number | null
  • Optional planWidth?: number | null

LinkFeatureGroupToPackageInput

LinkFeatureGroupToPackageInput: { environmentId?: InputMaybe<Scalars["UUID"]>; featureGroupId: Scalars["UUID"]; packageId: Scalars["UUID"] }

Link feature group to package entitlements input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureGroupId: Scalars["UUID"]

    The group id to link to the package

  • packageId: Scalars["UUID"]

    The unique identifier of the entitlement package

ListAppStoreApplicationsInput

ListAppStoreApplicationsInput: { environmentId?: InputMaybe<Scalars["UUID"]> }

Input for listing App Store applications

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

ListAppStoreSubscriptionsInput

ListAppStoreSubscriptionsInput: { applicationId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]> }

Input for listing App Store subscriptions for an application

Type declaration

  • applicationId: Scalars["String"]

    ID of the App Store application

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

ListAwsProductDimensionsInput

ListAwsProductDimensionsInput: { environmentId?: InputMaybe<Scalars["UUID"]>; productId: Scalars["String"] }

Input for retrieving AWS Marketplace product dimensions

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • productId: Scalars["String"]

    AWS product ID to fetch dimensions for

ListAwsProductsInput

ListAwsProductsInput: { environmentId?: InputMaybe<Scalars["UUID"]> }

Input parameters for listing available AWS Marketplace products

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

MakeMaybe

MakeMaybe<T, K>: Omit<T, K> & { [ SubKey in K]: Maybe<T[SubKey]> }

Type parameters

  • T

  • K: keyof T

MakeOptional

MakeOptional<T, K>: Omit<T, K> & { [ SubKey in K]?: Maybe<T[SubKey]> }

Type parameters

  • T

  • K: keyof T

MarkInvoiceAsPaidInput

MarkInvoiceAsPaidInput: { environmentId?: InputMaybe<Scalars["UUID"]>; subscriptionId: Scalars["String"] }

Input for triggering the subscription invoice as paid

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    Environment ID

  • subscriptionId: Scalars["String"]

    The subscription entity id to trigger mark invoice as paid

Maybe

Maybe<T>: T | null

Type parameters

  • T

MemberFilter

MemberFilter: { and?: InputMaybe<MemberFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; email?: InputMaybe<StringFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<MemberFilter[]>; user?: InputMaybe<MemberFilterUserFilter> }

Type declaration

MemberFilterUserFilter

MemberFilterUserFilter: { and?: InputMaybe<MemberFilterUserFilter[]>; email?: InputMaybe<StringFieldComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<MemberFilterUserFilter[]> }

Type declaration

MemberSort

MemberSort: { direction: SortDirection; field: MemberSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

MergeEnvironmentInput

MergeEnvironmentInput: { destinationEnvironmentName?: InputMaybe<Scalars["String"]>; destinationEnvironmentSlug?: InputMaybe<Scalars["String"]>; destinationEnvironmentType?: InputMaybe<EnvironmentType>; mergeConfiguration?: InputMaybe<EnvironmentMergeConfigurationInput>; migrationType?: InputMaybe<PublishMigrationType>; sourceEnvironmentSlug?: InputMaybe<Scalars["String"]>; sourceTemplate?: InputMaybe<Scalars["JSON"]> }

Input type for mergeEnvironment mutation

Type declaration

  • Optional destinationEnvironmentName?: InputMaybe<Scalars["String"]>

    Name for the new environment if destinationEnvironmentSlug is not provided

  • Optional destinationEnvironmentSlug?: InputMaybe<Scalars["String"]>

    Slug of the destination environment to merge into. If not provided, a new environment will be created

  • Optional destinationEnvironmentType?: InputMaybe<EnvironmentType>

    Type for the new environment if destinationEnvironmentSlug is not provided

  • Optional mergeConfiguration?: InputMaybe<EnvironmentMergeConfigurationInput>

    Optional configuration to customize the merge process

  • Optional migrationType?: InputMaybe<PublishMigrationType>

    How to migrate customers to newer plan version of updated plans. Default is not to migrate existing customers

  • Optional sourceEnvironmentSlug?: InputMaybe<Scalars["String"]>

    Slug of the source environment to merge from. Either this or sourceTemplate must be provided

  • Optional sourceTemplate?: InputMaybe<Scalars["JSON"]>

    A template dump of the source environment. Either this or sourceEnvironmentSlug must be provided

MeterAggregation

MeterAggregation: { field?: InputMaybe<Scalars["String"]>; function: AggregationFunction }

Defines how meter data should be aggregated using a specified aggregation function

Type declaration

  • Optional field?: InputMaybe<Scalars["String"]>

    The data field to which the aggregation function will be applied

  • function: AggregationFunction

    The aggregation function to apply to the data (e.g. SUM, AVG, COUNT)

MeterConditionInput

MeterConditionInput: { field: Scalars["String"]; operation: ConditionOperation; value?: InputMaybe<Scalars["String"]>; values?: InputMaybe<Scalars["String"][]> }

A condition that will be used to filter the data

Type declaration

  • field: Scalars["String"]

    The field to filter on

  • operation: ConditionOperation

    The operation to perform on the field

  • Optional value?: InputMaybe<Scalars["String"]>

    The value of the field to filter on

  • Optional values?: InputMaybe<Scalars["String"][]>

    The values of the field to filter on (used for IN operation)

MeterFilterDefinitionInput

MeterFilterDefinitionInput: { conditions: MeterConditionInput[] }

A configuration defining how to filter the data

Type declaration

MeterTypeFilterComparison

MeterTypeFilterComparison: { eq?: InputMaybe<MeterType>; gt?: InputMaybe<MeterType>; gte?: InputMaybe<MeterType>; iLike?: InputMaybe<MeterType>; in?: InputMaybe<MeterType[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<MeterType>; lt?: InputMaybe<MeterType>; lte?: InputMaybe<MeterType>; neq?: InputMaybe<MeterType>; notILike?: InputMaybe<MeterType>; notIn?: InputMaybe<MeterType[]>; notLike?: InputMaybe<MeterType> }

Type declaration

MeteredEntitlementFallback

MeteredEntitlementFallback: { hasAccess: boolean; isUnlimited?: boolean; usageLimit?: number }

Type declaration

  • hasAccess: boolean
  • Optional isUnlimited?: boolean
  • Optional usageLimit?: number

MeteredEntitlementOptions

MeteredEntitlementOptions: { fallback?: MeteredEntitlementFallback; requestedUsage?: number; shouldTrack?: boolean }

Type declaration

  • Optional fallback?: MeteredEntitlementFallback
  • Optional requestedUsage?: number
  • Optional shouldTrack?: boolean
    deprecated

    not in use anymore

MigratePackageFeatureGroupsToLatestInput

MigratePackageFeatureGroupsToLatestInput: { accountId: Scalars["UUID"]; entitlements: PackageEntitlementInput[]; environmentId?: InputMaybe<Scalars["UUID"]>; packageId: Scalars["UUID"] }

Input for migrating package feature groups to latest version

Type declaration

  • accountId: Scalars["UUID"]

    The unique identifier for the account

  • entitlements: PackageEntitlementInput[]

    List of package entitlements that are new to the feature groups

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • packageId: Scalars["UUID"]

    The unique identifier of the entitlement package

MigrateSubscriptionToLatestMutation

MigrateSubscriptionToLatestMutation: { __typename?: "Mutation"; migrateSubscriptionToLatest: { __typename?: "CustomerSubscription"; subscriptionId: string } }

Type declaration

  • Optional __typename?: "Mutation"
  • migrateSubscriptionToLatest: { __typename?: "CustomerSubscription"; subscriptionId: string }
    • Optional __typename?: "CustomerSubscription"
    • subscriptionId: string

MigrateSubscriptionToLatestMutationVariables

MigrateSubscriptionToLatestMutationVariables: Exact<{ input: SubscriptionMigrationInput }>

MinimumSpendInput

MinimumSpendInput: { billingPeriod: BillingPeriod; minimum: MoneyInputDto }

Minimum spend input

Type declaration

MockPaywallAddonDependencyFragment

MockPaywallAddonDependencyFragment: { __typename?: "PaywallAddon"; description?: string | null; displayName: string; refId: string }

Type declaration

  • Optional __typename?: "PaywallAddon"
  • Optional description?: string | null
  • displayName: string
  • refId: string

MockPaywallAddonFragment

MockPaywallAddonFragment: { __typename?: "PaywallAddon"; additionalMetaData?: any | null; billingId?: string | null; dependencies?: ({ __typename?: "PaywallAddon" } & MockPaywallAddonDependencyFragment)[] | null; description?: string | null; displayName: string; entitlements: ({ __typename?: "Entitlement" } & MockPaywallPackageEntitlementFragment)[]; hiddenFromWidgets?: WidgetType[] | null; maxQuantity?: number | null; prices: ({ __typename?: "PaywallPrice" } & MockPaywallPriceFragment)[]; pricingType?: PricingType | null; refId: string }

Type declaration

MockPaywallPackageEntitlementFragment

MockPaywallPackageEntitlementFragment: { __typename?: "Entitlement"; displayNameOverride?: string | null; enumValues?: string[] | null; feature?: { __typename?: "EntitlementFeature"; additionalMetaData?: any | null; description?: string | null; displayName: string; featureType: FeatureType; featureUnits?: string | null; featureUnitsPlural?: string | null; meterType?: MeterType | null; refId: string } | null; hasSoftLimit?: boolean | null; hasUnlimitedUsage: boolean; hiddenFromWidgets?: WidgetType[] | null; isGranted: boolean; resetPeriod?: EntitlementResetPeriod | null; usageLimit?: number | null }

Type declaration

  • Optional __typename?: "Entitlement"
  • Optional displayNameOverride?: string | null
  • Optional enumValues?: string[] | null
  • Optional feature?: { __typename?: "EntitlementFeature"; additionalMetaData?: any | null; description?: string | null; displayName: string; featureType: FeatureType; featureUnits?: string | null; featureUnitsPlural?: string | null; meterType?: MeterType | null; refId: string } | null
  • Optional hasSoftLimit?: boolean | null
  • hasUnlimitedUsage: boolean
  • Optional hiddenFromWidgets?: WidgetType[] | null
  • isGranted: boolean
  • Optional resetPeriod?: EntitlementResetPeriod | null
  • Optional usageLimit?: number | null

MockPaywallPlanCompatiblePackageGroupsFragment

MockPaywallPlanCompatiblePackageGroupsFragment: { __typename?: "PaywallPlanCompatiblePackageGroup"; addons?: ({ __typename?: "PaywallAddon" } & MockPaywallAddonFragment)[] | null; description?: string | null; displayName: string; options: { __typename?: "PaywallPlanCompatiblePackageGroupOptions"; freeItems?: number | null; minItems?: number | null }; packageGroupId: string }

Type declaration

  • Optional __typename?: "PaywallPlanCompatiblePackageGroup"
  • Optional addons?: ({ __typename?: "PaywallAddon" } & MockPaywallAddonFragment)[] | null
  • Optional description?: string | null
  • displayName: string
  • options: { __typename?: "PaywallPlanCompatiblePackageGroupOptions"; freeItems?: number | null; minItems?: number | null }
    • Optional __typename?: "PaywallPlanCompatiblePackageGroupOptions"
    • Optional freeItems?: number | null
    • Optional minItems?: number | null
  • packageGroupId: string

MockPaywallPlanFragment

MockPaywallPlanFragment: { __typename?: "PaywallPlan"; additionalMetaData?: any | null; basePlan?: { __typename?: "PaywallBasePlan"; displayName: string; refId: string } | null; billingId?: string | null; compatibleAddons?: ({ __typename?: "PaywallAddon" } & MockPaywallAddonFragment)[] | null; compatiblePackageGroups?: ({ __typename?: "PaywallPlanCompatiblePackageGroup" } & MockPaywallPlanCompatiblePackageGroupsFragment)[] | null; defaultTrialConfig?: { __typename?: "DefaultTrialConfig"; budget?: { __typename?: "BudgetConfiguration"; limit: number } | null; duration: number; trialEndBehavior?: TrialEndBehavior | null; units: TrialPeriodUnits } | null; description?: string | null; displayName: string; entitlements?: ({ __typename?: "Entitlement" } & MockPaywallPackageEntitlementFragment)[] | null; inheritedEntitlements?: ({ __typename?: "Entitlement" } & MockPaywallPackageEntitlementFragment)[] | null; prices: ({ __typename?: "PaywallPrice" } & MockPaywallPriceFragment)[]; pricingType?: PricingType | null; product: { __typename?: "PaywallProduct"; additionalMetaData?: any | null; description?: string | null; displayName?: string | null; refId: string }; refId: string }

Type declaration

  • Optional __typename?: "PaywallPlan"
  • Optional additionalMetaData?: any | null
  • Optional basePlan?: { __typename?: "PaywallBasePlan"; displayName: string; refId: string } | null
  • Optional billingId?: string | null
  • Optional compatibleAddons?: ({ __typename?: "PaywallAddon" } & MockPaywallAddonFragment)[] | null
  • Optional compatiblePackageGroups?: ({ __typename?: "PaywallPlanCompatiblePackageGroup" } & MockPaywallPlanCompatiblePackageGroupsFragment)[] | null
  • Optional defaultTrialConfig?: { __typename?: "DefaultTrialConfig"; budget?: { __typename?: "BudgetConfiguration"; limit: number } | null; duration: number; trialEndBehavior?: TrialEndBehavior | null; units: TrialPeriodUnits } | null
  • Optional description?: string | null
  • displayName: string
  • Optional entitlements?: ({ __typename?: "Entitlement" } & MockPaywallPackageEntitlementFragment)[] | null
  • Optional inheritedEntitlements?: ({ __typename?: "Entitlement" } & MockPaywallPackageEntitlementFragment)[] | null
  • prices: ({ __typename?: "PaywallPrice" } & MockPaywallPriceFragment)[]
  • Optional pricingType?: PricingType | null
  • product: { __typename?: "PaywallProduct"; additionalMetaData?: any | null; description?: string | null; displayName?: string | null; refId: string }
    • Optional __typename?: "PaywallProduct"
    • Optional additionalMetaData?: any | null
    • Optional description?: string | null
    • Optional displayName?: string | null
    • refId: string
  • refId: string

MockPaywallPriceFragment

MockPaywallPriceFragment: { __typename?: "PaywallPrice"; billingCountryCode?: string | null; billingId?: string | null; billingModel: BillingModel; billingPeriod: BillingPeriod; blockSize?: number | null; creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string } | null; feature?: { __typename?: "EntitlementFeature"; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; refId: string } | null; maxUnitQuantity?: number | null; minUnitQuantity?: number | null; price?: { __typename?: "Money"; amount: number; currency: Currency } | null; tiers?: ({ __typename?: "PriceTier" } & PriceTierFragment)[] | null; tiersMode?: TiersMode | null }

Type declaration

  • Optional __typename?: "PaywallPrice"
  • Optional billingCountryCode?: string | null
  • Optional billingId?: string | null
  • billingModel: BillingModel
  • billingPeriod: BillingPeriod
  • Optional blockSize?: number | null
  • Optional creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string } | null
  • Optional feature?: { __typename?: "EntitlementFeature"; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; refId: string } | null
  • Optional maxUnitQuantity?: number | null
  • Optional minUnitQuantity?: number | null
  • Optional price?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional tiers?: ({ __typename?: "PriceTier" } & PriceTierFragment)[] | null
  • Optional tiersMode?: TiersMode | null

Money

Money: { amount: number; currency: string }

Type declaration

  • amount: number
  • currency: string

MoneyInputDto

MoneyInputDto: { amount: Scalars["Float"]; currency?: InputMaybe<Currency> }

Money Input

Type declaration

MonthlyResetPeriodConfigInput

MonthlyResetPeriodConfigInput: { accordingTo: MonthlyAccordingTo }

Monthly reset period config input

Type declaration

NumberFieldComparison

NumberFieldComparison: { between?: InputMaybe<NumberFieldComparisonBetween>; eq?: InputMaybe<Scalars["Float"]>; gt?: InputMaybe<Scalars["Float"]>; gte?: InputMaybe<Scalars["Float"]>; in?: InputMaybe<Scalars["Float"][]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; lt?: InputMaybe<Scalars["Float"]>; lte?: InputMaybe<Scalars["Float"]>; neq?: InputMaybe<Scalars["Float"]>; notBetween?: InputMaybe<NumberFieldComparisonBetween>; notIn?: InputMaybe<Scalars["Float"][]> }

Type declaration

NumberFieldComparisonBetween

NumberFieldComparisonBetween: { lower: Scalars["Float"]; upper: Scalars["Float"] }

Type declaration

NumericEntitlementFallback

NumericEntitlementFallback: { hasAccess: boolean; isUnlimited?: boolean; value?: number }

Type declaration

  • hasAccess: boolean
  • Optional isUnlimited?: boolean
  • Optional value?: number

NumericEntitlementOptions

NumericEntitlementOptions: { fallback?: NumericEntitlementFallback; shouldTrack?: boolean }

Type declaration

OfferFilter

OfferFilter: { and?: InputMaybe<OfferFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isDefault?: InputMaybe<BooleanFieldComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; offerId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<OfferFilter[]>; status?: InputMaybe<OfferStatusFilterComparison>; version?: InputMaybe<IntFieldComparison> }

Type declaration

OfferSort

OfferSort: { direction: SortDirection; field: OfferSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

OfferStatusFilterComparison

OfferStatusFilterComparison: { eq?: InputMaybe<OfferStatus>; gt?: InputMaybe<OfferStatus>; gte?: InputMaybe<OfferStatus>; iLike?: InputMaybe<OfferStatus>; in?: InputMaybe<OfferStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<OfferStatus>; lt?: InputMaybe<OfferStatus>; lte?: InputMaybe<OfferStatus>; neq?: InputMaybe<OfferStatus>; notILike?: InputMaybe<OfferStatus>; notIn?: InputMaybe<OfferStatus[]>; notLike?: InputMaybe<OfferStatus> }

Type declaration

OnCreditBalanceUpdatedSubscription

OnCreditBalanceUpdatedSubscription: { __typename?: "Subscription"; creditBalanceUpdated: { __typename?: "CreditBalanceUpdated" } & CreditBalanceUpdatedPayloadFragment }

Type declaration

OnCreditBalanceUpdatedSubscriptionVariables

OnCreditBalanceUpdatedSubscriptionVariables: Exact<{}>

OnEntitlementsUpdatedSubscription

OnEntitlementsUpdatedSubscription: { __typename?: "Subscription"; entitlementsUpdated: { __typename?: "EntitlementsUpdated" } & EntitlementsUpdatedPayloadFragment }

Type declaration

OnEntitlementsUpdatedSubscriptionVariables

OnEntitlementsUpdatedSubscriptionVariables: Exact<{}>

OnPackagePublishedSubscription

OnPackagePublishedSubscription: { __typename?: "Subscription"; packagePublished: { __typename?: "PackagePublished" } & PackagePublishedPayloadFragment }

Type declaration

OnPackagePublishedSubscriptionVariables

OnPackagePublishedSubscriptionVariables: Exact<{}>

OnUsageUpdatedSubscription

OnUsageUpdatedSubscription: { __typename?: "Subscription"; usageUpdated: { __typename?: "UsageUpdated" } & EntitlementUsageUpdatedFragment }

Type declaration

OnUsageUpdatedSubscriptionVariables

OnUsageUpdatedSubscriptionVariables: Exact<{}>

OpenFgaCredentialsInput

OpenFgaCredentialsInput: { apiAudience: Scalars["String"]; apiTokenIssuer: Scalars["String"]; apiUrl: Scalars["String"]; clientId: Scalars["String"]; clientSecret: Scalars["String"]; storeId?: InputMaybe<Scalars["String"]> }

Input configuration for OpenFGA integration

Type declaration

  • apiAudience: Scalars["String"]

    Audience for the OpenFGA API

  • apiTokenIssuer: Scalars["String"]

    Issuer of the OpenFGA API token

  • apiUrl: Scalars["String"]

    URL of the OpenFGA API

  • clientId: Scalars["String"]

    Client ID for the OpenFGA API

  • clientSecret: Scalars["String"]

    Client secret for OpenFGA

  • Optional storeId?: InputMaybe<Scalars["String"]>

    ID of the OpenFGA store

OverageEntitlementCreateInput

OverageEntitlementCreateInput: { behavior?: InputMaybe<EntitlementBehavior>; description?: InputMaybe<Scalars["String"]>; displayNameOverride?: InputMaybe<Scalars["String"]>; enumValues?: InputMaybe<Scalars["String"][]>; featureGroupId?: InputMaybe<Scalars["UUID"]>; featureId: Scalars["UUID"]; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; isCustom?: InputMaybe<Scalars["Boolean"]>; isGranted?: InputMaybe<Scalars["Boolean"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; order?: InputMaybe<Scalars["Float"]>; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Overage Entitlement Create Input

Type declaration

  • Optional behavior?: InputMaybe<EntitlementBehavior>

    The behavior of the entitlement

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the entitlement

  • Optional displayNameOverride?: InputMaybe<Scalars["String"]>

    The display name override of the entitlement

  • Optional enumValues?: InputMaybe<Scalars["String"][]>

    The enum values of the entitlement

  • Optional featureGroupId?: InputMaybe<Scalars["UUID"]>

    Primary feature group ID (first in the array) associated with this entitlement

  • featureId: Scalars["UUID"]

    The unique identifier of the entitlement feature

  • Optional hasSoftLimit?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has a soft limit

  • Optional hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has an unlimited usage

  • Optional hiddenFromWidgets?: InputMaybe<WidgetType[]>

    Whether the entitlement is hidden from widgets

  • Optional isCustom?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement is a custom entitlement

  • Optional isGranted?: InputMaybe<Scalars["Boolean"]>

    Whether entitlement grant is active

  • Optional monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>

    The monthly reset period configuration of the entitlement, defined when reset period is monthly

  • Optional order?: InputMaybe<Scalars["Float"]>

    The order of the entitlement in the entitlement list

  • Optional resetPeriod?: InputMaybe<EntitlementResetPeriod>

    The reset period of the entitlement

  • Optional usageLimit?: InputMaybe<Scalars["Float"]>

    The usage limit of the entitlement

  • Optional weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>

    The weekly reset period configuration of the entitlement, defined when reset period is weekly

  • Optional yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>

    The yearly reset period configuration of the entitlement, defined when reset period is yearly

OveragePriceFragment

OveragePriceFragment: { __typename?: "Price"; billingCountryCode?: string | null; billingId?: string | null; billingModel: BillingModel; billingPeriod: BillingPeriod; feature?: { __typename?: "Feature"; description?: string | null; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; refId: string } | null; price?: { __typename?: "Money"; amount: number; currency: Currency } | null; tiers?: ({ __typename?: "PriceTier" } & PriceTierFragment)[] | null; tiersMode?: TiersMode | null }

Type declaration

  • Optional __typename?: "Price"
  • Optional billingCountryCode?: string | null
  • Optional billingId?: string | null
  • billingModel: BillingModel
  • billingPeriod: BillingPeriod
  • Optional feature?: { __typename?: "Feature"; description?: string | null; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; refId: string } | null
  • Optional price?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional tiers?: ({ __typename?: "PriceTier" } & PriceTierFragment)[] | null
  • Optional tiersMode?: TiersMode | null

OveragePricingModelCreateInput

OveragePricingModelCreateInput: { billingCadence?: InputMaybe<BillingCadence>; billingId?: InputMaybe<Scalars["String"]>; billingModel: BillingModel; entitlement?: InputMaybe<OverageEntitlementCreateInput>; featureId?: InputMaybe<Scalars["String"]>; pricePeriods: PricePeriodInput[]; topUpCustomCurrencyId?: InputMaybe<Scalars["String"]> }

Overage Pricing Model Create Input

Type declaration

PackageCreditEntitlementInput

PackageCreditEntitlementInput: { amount: Scalars["Float"]; behavior?: InputMaybe<EntitlementBehavior>; cadence: CreditCadence; customCurrencyId: Scalars["String"]; description?: InputMaybe<Scalars["String"]>; displayNameOverride?: InputMaybe<Scalars["String"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; isCustom?: InputMaybe<Scalars["Boolean"]>; isGranted?: InputMaybe<Scalars["Boolean"]>; order?: InputMaybe<Scalars["Float"]> }

Package credit entitlement input

Type declaration

  • amount: Scalars["Float"]

    The amount of credits

  • Optional behavior?: InputMaybe<EntitlementBehavior>

    The behavior of the entitlement

  • cadence: CreditCadence

    The cadence of the credit entitlement

  • customCurrencyId: Scalars["String"]

    The unique identifier of the custom currency

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the entitlement

  • Optional displayNameOverride?: InputMaybe<Scalars["String"]>

    The display name override of the entitlement

  • Optional hiddenFromWidgets?: InputMaybe<WidgetType[]>

    Whether the entitlement is hidden from widgets

  • Optional isCustom?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement is a custom entitlement

  • Optional isGranted?: InputMaybe<Scalars["Boolean"]>

    Whether entitlement grant is active

  • Optional order?: InputMaybe<Scalars["Float"]>

    The order of the entitlement in the entitlement list

PackageCreditEntitlementUpdateInput

PackageCreditEntitlementUpdateInput: { amount?: InputMaybe<Scalars["Float"]>; behavior?: InputMaybe<EntitlementBehavior>; cadence?: InputMaybe<CreditCadence>; description?: InputMaybe<Scalars["String"]>; displayNameOverride?: InputMaybe<Scalars["String"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; isCustom?: InputMaybe<Scalars["Boolean"]>; isGranted?: InputMaybe<Scalars["Boolean"]>; order?: InputMaybe<Scalars["Float"]> }

Package credit entitlement update input

Type declaration

PackageDtoFilter

PackageDtoFilter: { and?: InputMaybe<PackageDtoFilter[]>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; offer?: InputMaybe<PackageDtoFilterOfferFilter>; or?: InputMaybe<PackageDtoFilter[]>; pricingType?: InputMaybe<PricingTypeFilterComparison>; productId?: InputMaybe<StringFieldComparison>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<PackageStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

PackageDtoFilterOfferFilter

PackageDtoFilterOfferFilter: { and?: InputMaybe<PackageDtoFilterOfferFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isDefault?: InputMaybe<BooleanFieldComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; offerId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<PackageDtoFilterOfferFilter[]>; status?: InputMaybe<OfferStatusFilterComparison>; version?: InputMaybe<IntFieldComparison> }

Type declaration

PackageDtoSort

PackageDtoSort: { direction: SortDirection; field: PackageDtoSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

PackageEntitlement

PackageEntitlement: { displayNameOverride?: PackageEntitlementFragment["displayNameOverride"]; enumValues?: string[] | null; feature?: EntitlementFeature; hasUnlimitedUsage?: boolean | null; hiddenFromWidgets?: PackageEntitlementFragment["hiddenFromWidgets"]; isCustom?: boolean; isGranted: PackageEntitlementFragment["isGranted"]; resetPeriod?: EntitlementResetPeriod | null; usageLimit: number }

Type declaration

PackageEntitlementFilter

PackageEntitlementFilter: { and?: InputMaybe<PackageEntitlementFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; feature?: InputMaybe<PackageEntitlementFilterFeatureFilter>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<PackageEntitlementFilter[]>; package?: InputMaybe<PackageEntitlementFilterPackageDtoFilter>; packageId?: InputMaybe<StringFieldComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

PackageEntitlementFilterFeatureFilter

PackageEntitlementFilterFeatureFilter: { and?: InputMaybe<PackageEntitlementFilterFeatureFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; featureStatus?: InputMaybe<FeatureStatusFilterComparison>; featureType?: InputMaybe<FeatureTypeFilterComparison>; id?: InputMaybe<UuidFilterComparison>; meterType?: InputMaybe<MeterTypeFilterComparison>; or?: InputMaybe<PackageEntitlementFilterFeatureFilter[]>; refId?: InputMaybe<StringFieldComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

PackageEntitlementFilterPackageDtoFilter

PackageEntitlementFilterPackageDtoFilter: { and?: InputMaybe<PackageEntitlementFilterPackageDtoFilter[]>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<PackageEntitlementFilterPackageDtoFilter[]>; pricingType?: InputMaybe<PricingTypeFilterComparison>; productId?: InputMaybe<StringFieldComparison>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<PackageStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

PackageEntitlementFragment

PackageEntitlementFragment: { __typename?: "PackageEntitlement"; displayNameOverride?: string | null; enumValues?: string[] | null; feature: { __typename?: "Feature"; additionalMetaData?: any | null; description?: string | null; displayName: string; featureType: FeatureType; featureUnits?: string | null; featureUnitsPlural?: string | null; meterType?: MeterType | null; refId: string }; featureId: string; hasSoftLimit?: boolean | null; hasUnlimitedUsage?: boolean | null; hiddenFromWidgets?: WidgetType[] | null; isCustom?: boolean | null; isGranted: boolean; resetPeriod?: EntitlementResetPeriod | null; usageLimit?: number | null }

Type declaration

  • Optional __typename?: "PackageEntitlement"
  • Optional displayNameOverride?: string | null
  • Optional enumValues?: string[] | null
  • feature: { __typename?: "Feature"; additionalMetaData?: any | null; description?: string | null; displayName: string; featureType: FeatureType; featureUnits?: string | null; featureUnitsPlural?: string | null; meterType?: MeterType | null; refId: string }
    • Optional __typename?: "Feature"
    • Optional additionalMetaData?: any | null
    • Optional description?: string | null
    • displayName: string
    • featureType: FeatureType
    • Optional featureUnits?: string | null
    • Optional featureUnitsPlural?: string | null
    • Optional meterType?: MeterType | null
    • refId: string
  • featureId: string
  • Optional hasSoftLimit?: boolean | null
  • Optional hasUnlimitedUsage?: boolean | null
  • Optional hiddenFromWidgets?: WidgetType[] | null
  • Optional isCustom?: boolean | null
  • isGranted: boolean
  • Optional resetPeriod?: EntitlementResetPeriod | null
  • Optional usageLimit?: number | null

PackageEntitlementInput

PackageEntitlementInput: { behavior?: InputMaybe<EntitlementBehavior>; description?: InputMaybe<Scalars["String"]>; displayNameOverride?: InputMaybe<Scalars["String"]>; enumValues?: InputMaybe<Scalars["String"][]>; environmentId: Scalars["UUID"]; featureGroupId?: InputMaybe<Scalars["UUID"]>; featureId: Scalars["UUID"]; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; isCustom?: InputMaybe<Scalars["Boolean"]>; isGranted?: InputMaybe<Scalars["Boolean"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; order?: InputMaybe<Scalars["Float"]>; packageId: Scalars["UUID"]; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Package entitlement input

Type declaration

  • Optional behavior?: InputMaybe<EntitlementBehavior>

    The behavior of the entitlement

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the entitlement

  • Optional displayNameOverride?: InputMaybe<Scalars["String"]>

    The display name override of the entitlement

  • Optional enumValues?: InputMaybe<Scalars["String"][]>

    The enum values of the entitlement

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • Optional featureGroupId?: InputMaybe<Scalars["UUID"]>

    Primary feature group ID (first in the array) associated with this entitlement

  • featureId: Scalars["UUID"]

    The unique identifier of the entitlement feature

  • Optional hasSoftLimit?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has a soft limit

  • Optional hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has an unlimited usage

  • Optional hiddenFromWidgets?: InputMaybe<WidgetType[]>

    Whether the entitlement is hidden from widgets

  • Optional isCustom?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement is a custom entitlement

  • Optional isGranted?: InputMaybe<Scalars["Boolean"]>

    Whether entitlement grant is active

  • Optional monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>

    The monthly reset period configuration of the entitlement, defined when reset period is monthly

  • Optional order?: InputMaybe<Scalars["Float"]>

    The order of the entitlement in the entitlement list

  • packageId: Scalars["UUID"]

    The unique identifier of the entitlement package

  • Optional resetPeriod?: InputMaybe<EntitlementResetPeriod>

    The reset period of the entitlement

  • Optional usageLimit?: InputMaybe<Scalars["Float"]>

    The usage limit of the entitlement

  • Optional weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>

    The weekly reset period configuration of the entitlement, defined when reset period is weekly

  • Optional yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>

    The yearly reset period configuration of the entitlement, defined when reset period is yearly

PackageEntitlementSort

PackageEntitlementSort: { direction: SortDirection; field: PackageEntitlementSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

PackageEntitlementUpdateInput

PackageEntitlementUpdateInput: { behavior?: InputMaybe<EntitlementBehavior>; description?: InputMaybe<Scalars["String"]>; displayNameOverride?: InputMaybe<Scalars["String"]>; enumValues?: InputMaybe<Scalars["String"][]>; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; isCustom?: InputMaybe<Scalars["Boolean"]>; isGranted?: InputMaybe<Scalars["Boolean"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; order?: InputMaybe<Scalars["Float"]>; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Package entitlement update input

Type declaration

PackageFeatureEntitlementInput

PackageFeatureEntitlementInput: { behavior?: InputMaybe<EntitlementBehavior>; description?: InputMaybe<Scalars["String"]>; displayNameOverride?: InputMaybe<Scalars["String"]>; enumValues?: InputMaybe<Scalars["String"][]>; featureGroupId?: InputMaybe<Scalars["UUID"]>; featureId: Scalars["String"]; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; isCustom?: InputMaybe<Scalars["Boolean"]>; isGranted?: InputMaybe<Scalars["Boolean"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; order?: InputMaybe<Scalars["Float"]>; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Package entitlement input

Type declaration

  • Optional behavior?: InputMaybe<EntitlementBehavior>

    The behavior of the entitlement

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the entitlement

  • Optional displayNameOverride?: InputMaybe<Scalars["String"]>

    The display name override of the entitlement

  • Optional enumValues?: InputMaybe<Scalars["String"][]>

    The enum values of the entitlement

  • Optional featureGroupId?: InputMaybe<Scalars["UUID"]>

    Primary feature group ID (first in the array) associated with this entitlement

  • featureId: Scalars["String"]

    The unique identifier of the entitlement feature

  • Optional hasSoftLimit?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has a soft limit

  • Optional hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has an unlimited usage

  • Optional hiddenFromWidgets?: InputMaybe<WidgetType[]>

    Whether the entitlement is hidden from widgets

  • Optional isCustom?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement is a custom entitlement

  • Optional isGranted?: InputMaybe<Scalars["Boolean"]>

    Whether entitlement grant is active

  • Optional monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>

    The monthly reset period configuration of the entitlement, defined when reset period is monthly

  • Optional order?: InputMaybe<Scalars["Float"]>

    The order of the entitlement in the entitlement list

  • Optional resetPeriod?: InputMaybe<EntitlementResetPeriod>

    The reset period of the entitlement

  • Optional usageLimit?: InputMaybe<Scalars["Float"]>

    The usage limit of the entitlement

  • Optional weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>

    The weekly reset period configuration of the entitlement, defined when reset period is weekly

  • Optional yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>

    The yearly reset period configuration of the entitlement, defined when reset period is yearly

PackageFeatureEntitlementUpdateInput

PackageFeatureEntitlementUpdateInput: { behavior?: InputMaybe<EntitlementBehavior>; description?: InputMaybe<Scalars["String"]>; displayNameOverride?: InputMaybe<Scalars["String"]>; enumValues?: InputMaybe<Scalars["String"][]>; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; isCustom?: InputMaybe<Scalars["Boolean"]>; isGranted?: InputMaybe<Scalars["Boolean"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; order?: InputMaybe<Scalars["Float"]>; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Package feature entitlement update input

Type declaration

PackageGroupFilter

PackageGroupFilter: { and?: InputMaybe<PackageGroupFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<PackageGroupFilter[]>; packageGroupId?: InputMaybe<StringFieldComparison>; product?: InputMaybe<PackageGroupFilterProductFilter>; productId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<PackageGroupStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

PackageGroupFilterProductFilter

PackageGroupFilterProductFilter: { and?: InputMaybe<PackageGroupFilterProductFilter[]>; awsMarketplaceProductCode?: InputMaybe<StringFieldComparison>; awsMarketplaceProductId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isDefaultProduct?: InputMaybe<BooleanFieldComparison>; multipleSubscriptions?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<PackageGroupFilterProductFilter[]>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<ProductStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

PackageGroupSort

PackageGroupSort: { direction: SortDirection; field: PackageGroupSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

PackageGroupStatusFilterComparison

PackageGroupStatusFilterComparison: { eq?: InputMaybe<PackageGroupStatus>; gt?: InputMaybe<PackageGroupStatus>; gte?: InputMaybe<PackageGroupStatus>; iLike?: InputMaybe<PackageGroupStatus>; in?: InputMaybe<PackageGroupStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<PackageGroupStatus>; lt?: InputMaybe<PackageGroupStatus>; lte?: InputMaybe<PackageGroupStatus>; neq?: InputMaybe<PackageGroupStatus>; notILike?: InputMaybe<PackageGroupStatus>; notIn?: InputMaybe<PackageGroupStatus[]>; notLike?: InputMaybe<PackageGroupStatus> }

Type declaration

PackagePricingInput

PackagePricingInput: { environmentId: Scalars["String"]; minimumSpend?: InputMaybe<MinimumSpendInput[]>; overageBillingPeriod?: InputMaybe<OverageBillingPeriod>; overagePricingModels?: InputMaybe<OveragePricingModelCreateInput[]>; packageId: Scalars["String"]; priceGroupPackageBillingId?: InputMaybe<Scalars["String"]>; pricingModels?: InputMaybe<PricingModelCreateInput[]>; pricingType: PricingType }

Package Pricing Input

Type declaration

PackagePublishInput

PackagePublishInput: { id: Scalars["UUID"]; migrationType: PublishMigrationType }

Package Publish Input

Type declaration

PackagePublishedPayloadFragment

PackagePublishedPayloadFragment: { __typename?: "PackagePublished"; accountId: string; environmentId: string; migrationType: PublishMigrationType; packageRefId: string; packageType: string; packageVersion: number }

Type declaration

  • Optional __typename?: "PackagePublished"
  • accountId: string
  • environmentId: string
  • migrationType: PublishMigrationType
  • packageRefId: string
  • packageType: string
  • packageVersion: number

PackageStatusFilterComparison

PackageStatusFilterComparison: { eq?: InputMaybe<PackageStatus>; gt?: InputMaybe<PackageStatus>; gte?: InputMaybe<PackageStatus>; iLike?: InputMaybe<PackageStatus>; in?: InputMaybe<PackageStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<PackageStatus>; lt?: InputMaybe<PackageStatus>; lte?: InputMaybe<PackageStatus>; neq?: InputMaybe<PackageStatus>; notILike?: InputMaybe<PackageStatus>; notIn?: InputMaybe<PackageStatus[]>; notLike?: InputMaybe<PackageStatus> }

Type declaration

PageInfoFragment

PageInfoFragment: { __typename?: "PageInfo"; endCursor?: any | null; hasNextPage?: boolean | null; hasPreviousPage?: boolean | null; startCursor?: any | null }

Type declaration

  • Optional __typename?: "PageInfo"
  • Optional endCursor?: any | null
  • Optional hasNextPage?: boolean | null
  • Optional hasPreviousPage?: boolean | null
  • Optional startCursor?: any | null

PaginatedResult

PaginatedResult<T>: { data: T[]; pageInfo: PageInfoFragment; totalCount?: number }

Type parameters

  • T

Type declaration

PaymentCollectionFilterComparison

PaymentCollectionFilterComparison: { eq?: InputMaybe<PaymentCollection>; gt?: InputMaybe<PaymentCollection>; gte?: InputMaybe<PaymentCollection>; iLike?: InputMaybe<PaymentCollection>; in?: InputMaybe<PaymentCollection[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<PaymentCollection>; lt?: InputMaybe<PaymentCollection>; lte?: InputMaybe<PaymentCollection>; neq?: InputMaybe<PaymentCollection>; notILike?: InputMaybe<PaymentCollection>; notIn?: InputMaybe<PaymentCollection[]>; notLike?: InputMaybe<PaymentCollection> }

Type declaration

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

PaymentSessionFragment

PaymentSessionFragment: { __typename?: "PaymentSession"; token: string }

Type declaration

  • Optional __typename?: "PaymentSession"
  • token: string

PaymentSessionInput

PaymentSessionInput: { billingCountryCode?: InputMaybe<Scalars["String"]>; customerId: Scalars["String"]; planId: Scalars["String"] }

The billing payment session input

Type declaration

  • Optional billingCountryCode?: InputMaybe<Scalars["String"]>

    The billing country code of the plan to create payment session

  • customerId: Scalars["String"]

    Customer ID

  • planId: Scalars["String"]

    The plan ID to create payment session

Paywall

Paywall: { activeSubscriptions: Subscription[] | null; configuration?: PaywallConfiguration | null; currency: PaywallCurrency; customer: Customer | null; paywallCalculatedPricePoints?: PaywallCalculatedPricePoint[] | null; plans: Plan[]; resource: CustomerResource | null }

Type declaration

PaywallCalculatedPricePoint

PaywallCalculatedPricePoint: Omit<PaywallCalculatedPricePointsFragment, "__typename">

PaywallCalculatedPricePointsFragment

PaywallCalculatedPricePointsFragment: { __typename?: "PaywallPricePoint"; additionalChargesMayApply?: boolean | null; amount: number; billingCountryCode?: string | null; billingPeriod: BillingPeriod; currency: Currency; feature?: { __typename?: "Feature"; description?: string | null; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; refId: string } | null; planId: string }

Type declaration

  • Optional __typename?: "PaywallPricePoint"
  • Optional additionalChargesMayApply?: boolean | null
  • amount: number
  • Optional billingCountryCode?: string | null
  • billingPeriod: BillingPeriod
  • currency: Currency
  • Optional feature?: { __typename?: "Feature"; description?: string | null; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; refId: string } | null
  • planId: string

PaywallColorsPaletteInput

PaywallColorsPaletteInput: { backgroundColor?: InputMaybe<Scalars["String"]>; borderColor?: InputMaybe<Scalars["String"]>; currentPlanBackground?: InputMaybe<Scalars["String"]>; primary?: InputMaybe<Scalars["String"]>; textColor?: InputMaybe<Scalars["String"]> }

Input for customizing paywall-specific color elements.

Type declaration

  • Optional backgroundColor?: InputMaybe<Scalars["String"]>

    Background color of the widget.

  • Optional borderColor?: InputMaybe<Scalars["String"]>

    Color applied to widget borders or separators.

  • Optional currentPlanBackground?: InputMaybe<Scalars["String"]>

    Background color for the customer’s current plan section in the paywall.

  • Optional primary?: InputMaybe<Scalars["String"]>

    Primary accent color used throughout the widget.

  • Optional textColor?: InputMaybe<Scalars["String"]>

    Default color used for text content.

PaywallConfiguration

PaywallConfiguration: Omit<PaywallConfigurationFragment, "__typename">

PaywallConfigurationFragment

PaywallConfigurationFragment: { __typename?: "PaywallConfiguration"; customCss?: string | null; layout?: ({ __typename?: "PaywallLayoutConfiguration" } & LayoutConfigurationFragment) | null; palette?: { __typename?: "PaywallColorsPalette"; backgroundColor?: string | null; borderColor?: string | null; currentPlanBackground?: string | null; primary?: string | null; textColor?: string | null } | null; typography?: ({ __typename?: "TypographyConfiguration" } & TypographyConfigurationFragment) | null }

Type declaration

  • Optional __typename?: "PaywallConfiguration"
  • Optional customCss?: string | null
  • Optional layout?: ({ __typename?: "PaywallLayoutConfiguration" } & LayoutConfigurationFragment) | null
  • Optional palette?: { __typename?: "PaywallColorsPalette"; backgroundColor?: string | null; borderColor?: string | null; currentPlanBackground?: string | null; primary?: string | null; textColor?: string | null } | null
  • Optional typography?: ({ __typename?: "TypographyConfiguration" } & TypographyConfigurationFragment) | null

PaywallConfigurationInput

PaywallConfigurationInput: { customCss?: InputMaybe<Scalars["String"]>; layout?: InputMaybe<PaywallLayoutConfigurationInput>; palette?: InputMaybe<PaywallColorsPaletteInput>; typography?: InputMaybe<TypographyConfigurationInput> }

Input for updating the paywall configuration.

Type declaration

PaywallCurrency

PaywallCurrency: Omit<PaywallCurrencyFragment, "__typename">

PaywallCurrencyFragment

PaywallCurrencyFragment: { __typename?: "PaywallCurrency"; code: Currency; symbol: string }

Type declaration

  • Optional __typename?: "PaywallCurrency"
  • code: Currency
  • symbol: string

PaywallFragment

PaywallFragment: { __typename?: "Paywall"; activeSubscriptions?: ({ __typename?: "CustomerSubscription" } & SubscriptionFragment)[] | null; configuration?: ({ __typename?: "PaywallConfiguration" } & PaywallConfigurationFragment) | null; currency: { __typename?: "PaywallCurrency" } & PaywallCurrencyFragment; customer?: ({ __typename?: "Customer" } & CustomerFragment) | null; paywallCalculatedPricePoints?: ({ __typename?: "PaywallPricePoint" } & PaywallCalculatedPricePointsFragment)[] | null; plans: ({ __typename?: "Plan" } & PlanFragment)[]; resource?: ({ __typename?: "CustomerResource" } & CustomerResourceFragment) | null }

Type declaration

PaywallLayoutConfigurationInput

PaywallLayoutConfigurationInput: { alignment?: InputMaybe<Alignment>; planMargin?: InputMaybe<Scalars["Float"]>; planPadding?: InputMaybe<Scalars["Float"]>; planWidth?: InputMaybe<Scalars["Float"]> }

Input for controlling the layout of pricing plans in the paywall.

Type declaration

  • Optional alignment?: InputMaybe<Alignment>

    Horizontal alignment of pricing plans, such as left, center, or right.

  • Optional planMargin?: InputMaybe<Scalars["Float"]>

    Outer spacing around each plan.

  • Optional planPadding?: InputMaybe<Scalars["Float"]>

    Inner spacing inside each plan card.

  • Optional planWidth?: InputMaybe<Scalars["Float"]>

    Width of each plan card displayed in the paywall.

Plan

Plan: { basePlan?: BasePlan; billingId?: string | null; compatibleAddons: Addon[]; compatiblePackageGroups: CompatiblePackageGroup[]; defaultTrialConfig?: DefaultTrialConfig | null; description?: string | null; displayName: string; entitlements: PackageEntitlement[]; id: string; inheritedEntitlements: PackageEntitlement[]; metadata?: Metadata | null; order: number; pricePoints: Price[]; pricingType?: PricingType | null; product: Product }

Type declaration

PlanCompatiblePackageGroupsFragment

PlanCompatiblePackageGroupsFragment: { __typename?: "PlanCompatiblePackageGroups"; addons?: ({ __typename?: "Addon" } & AddonFragment)[] | null; displayName: string; options: { __typename?: "PlanCompatiblePackageGroupOptions"; freeItems?: number | null; minItems?: number | null }; packageGroupId: string }

Type declaration

  • Optional __typename?: "PlanCompatiblePackageGroups"
  • Optional addons?: ({ __typename?: "Addon" } & AddonFragment)[] | null
  • displayName: string
  • options: { __typename?: "PlanCompatiblePackageGroupOptions"; freeItems?: number | null; minItems?: number | null }
    • Optional __typename?: "PlanCompatiblePackageGroupOptions"
    • Optional freeItems?: number | null
    • Optional minItems?: number | null
  • packageGroupId: string

PlanCreateInput

PlanCreateInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; awsMarketplacePlanDimension?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; description?: InputMaybe<Scalars["String"]>; displayName: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; parentPlanId?: InputMaybe<Scalars["String"]>; pricingType?: InputMaybe<PricingType>; productId: Scalars["String"]; refId?: InputMaybe<Scalars["String"]>; status?: InputMaybe<PackageStatus> }

Input for creating a plan

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    The additional meta data of the package

  • Optional awsMarketplacePlanDimension?: InputMaybe<Scalars["String"]>

    The AWS marketplace plan dimension of the package

  • Optional billingId?: InputMaybe<Scalars["String"]>

    The unique identifier for the entity in the billing provider

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the package

  • displayName: Scalars["String"]

    The display name of the package

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional hiddenFromWidgets?: InputMaybe<WidgetType[]>

    List of hidden widgets of the package

  • Optional parentPlanId?: InputMaybe<Scalars["String"]>

    The ID of the parent plan, if applicable

  • Optional pricingType?: InputMaybe<PricingType>

    The pricing type of the package

  • productId: Scalars["String"]

    The product id of the package

  • Optional refId?: InputMaybe<Scalars["String"]>

    The unique identifier for the entity

  • Optional status?: InputMaybe<PackageStatus>

    The status of the package

PlanFilter

PlanFilter: { and?: InputMaybe<PlanFilter[]>; billingId?: InputMaybe<StringFieldComparison>; compatibleAddons?: InputMaybe<PlanFilterAddonFilter>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; offer?: InputMaybe<PlanFilterOfferFilter>; or?: InputMaybe<PlanFilter[]>; pricingType?: InputMaybe<PricingTypeFilterComparison>; product?: InputMaybe<PlanFilterProductFilter>; productId?: InputMaybe<StringFieldComparison>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<PackageStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

PlanFilterAddonFilter

PlanFilterAddonFilter: { and?: InputMaybe<PlanFilterAddonFilter[]>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<PlanFilterAddonFilter[]>; pricingType?: InputMaybe<PricingTypeFilterComparison>; productId?: InputMaybe<StringFieldComparison>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<PackageStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

PlanFilterOfferFilter

PlanFilterOfferFilter: { and?: InputMaybe<PlanFilterOfferFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isDefault?: InputMaybe<BooleanFieldComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; offerId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<PlanFilterOfferFilter[]>; status?: InputMaybe<OfferStatusFilterComparison>; version?: InputMaybe<IntFieldComparison> }

Type declaration

PlanFilterProductFilter

PlanFilterProductFilter: { and?: InputMaybe<PlanFilterProductFilter[]>; awsMarketplaceProductCode?: InputMaybe<StringFieldComparison>; awsMarketplaceProductId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isDefaultProduct?: InputMaybe<BooleanFieldComparison>; multipleSubscriptions?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<PlanFilterProductFilter[]>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<ProductStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

PlanFragment

PlanFragment: { __typename?: "Plan"; additionalMetaData?: any | null; awsMarketplacePlanDimension?: string | null; basePlan?: { __typename?: "Plan"; displayName: string; refId: string } | null; billingId?: string | null; compatibleAddons?: ({ __typename?: "Addon" } & AddonFragment)[] | null; compatiblePackageGroups?: ({ __typename?: "PlanCompatiblePackageGroups" } & PlanCompatiblePackageGroupsFragment)[] | null; defaultTrialConfig?: { __typename?: "DefaultTrialConfig"; budget?: { __typename?: "BudgetConfiguration"; limit: number } | null; duration: number; trialEndBehavior?: TrialEndBehavior | null; units: TrialPeriodUnits } | null; description?: string | null; displayName: string; entitlements?: ({ __typename?: "PackageEntitlement" } & PackageEntitlementFragment)[] | null; hiddenFromWidgets?: WidgetType[] | null; id: any; inheritedEntitlements?: ({ __typename?: "PackageEntitlement" } & PackageEntitlementFragment)[] | null; overagePrices?: ({ __typename?: "Price" } & OveragePriceFragment)[] | null; prices?: ({ __typename?: "Price" } & PriceFragment)[] | null; pricingType?: PricingType | null; product: { __typename?: "Product" } & ProductFragment; refId: string; versionNumber: number }

Type declaration

  • Optional __typename?: "Plan"
  • Optional additionalMetaData?: any | null
  • Optional awsMarketplacePlanDimension?: string | null
  • Optional basePlan?: { __typename?: "Plan"; displayName: string; refId: string } | null
  • Optional billingId?: string | null
  • Optional compatibleAddons?: ({ __typename?: "Addon" } & AddonFragment)[] | null
  • Optional compatiblePackageGroups?: ({ __typename?: "PlanCompatiblePackageGroups" } & PlanCompatiblePackageGroupsFragment)[] | null
  • Optional defaultTrialConfig?: { __typename?: "DefaultTrialConfig"; budget?: { __typename?: "BudgetConfiguration"; limit: number } | null; duration: number; trialEndBehavior?: TrialEndBehavior | null; units: TrialPeriodUnits } | null
  • Optional description?: string | null
  • displayName: string
  • Optional entitlements?: ({ __typename?: "PackageEntitlement" } & PackageEntitlementFragment)[] | null
  • Optional hiddenFromWidgets?: WidgetType[] | null
  • id: any
  • Optional inheritedEntitlements?: ({ __typename?: "PackageEntitlement" } & PackageEntitlementFragment)[] | null
  • Optional overagePrices?: ({ __typename?: "Price" } & OveragePriceFragment)[] | null
  • Optional prices?: ({ __typename?: "Price" } & PriceFragment)[] | null
  • Optional pricingType?: PricingType | null
  • product: { __typename?: "Product" } & ProductFragment
  • refId: string
  • versionNumber: number

PlanSort

PlanSort: { direction: SortDirection; field: PlanSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

PlanUpdateInput

PlanUpdateInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; billingId?: InputMaybe<Scalars["String"]>; defaultTrialConfig?: InputMaybe<DefaultTrialConfigInputDto>; description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; hiddenFromWidgets?: InputMaybe<WidgetType[]>; id: Scalars["UUID"]; minimumSpend?: InputMaybe<MinimumSpendInput[]>; parentPlanId?: InputMaybe<Scalars["String"]>; status?: InputMaybe<PackageStatus> }

Input for updating a plan

Type declaration

PreparePaymentMethodFormInput

PreparePaymentMethodFormInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; integrationId?: InputMaybe<Scalars["String"]> }

Input for preparing a payment method form

Type declaration

  • customerId: Scalars["String"]

    Customer slug

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional integrationId?: InputMaybe<Scalars["String"]>

    The billing integration to use for this payment method

PreviewCreditGrantInput

PreviewCreditGrantInput: { amount: Scalars["Float"]; appliedCoupon?: InputMaybe<CreditGrantCouponInput>; billingInformation?: InputMaybe<CreditGrantBillingInfoInput>; cost: MoneyInputDto; currencyId: Scalars["String"]; customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; resourceId?: InputMaybe<Scalars["String"]> }

Preview credit grant input object, used to preview credits invoice before purchasing

Type declaration

PreviewNextInvoice

PreviewNextInvoice: { subscriptionId: string }

Type declaration

  • subscriptionId: string

PreviewNextInvoiceInput

PreviewNextInvoiceInput: { environmentId?: InputMaybe<Scalars["UUID"]>; subscriptionId: Scalars["String"] }

Input to preview the next invoice for a subscription

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The environment id of the subscription to preview

  • subscriptionId: Scalars["String"]

    The subscription id to preview

PreviewNextInvoiceMutation

PreviewNextInvoiceMutation: { __typename?: "Mutation"; previewNextInvoice: { __typename?: "SubscriptionInvoicePreview" } & SubscriptionInvoicePreviewFragment }

Type declaration

PreviewNextInvoiceMutationVariables

PreviewNextInvoiceMutationVariables: Exact<{ input: PreviewNextInvoiceInput }>

PreviewSubscription

PreviewSubscription: { addons?: SubscriptionEstimationAddon[]; billableFeatures?: BillableFeature[]; billingCountryCode?: string; billingInformation?: SubscriptionBillingInfo; billingPeriod?: BillingPeriod; customerId: string; payingCustomerId?: string; planId: string; promotionCode?: string; resourceId?: string; scheduleStrategy?: ScheduleStrategy; startDate?: Date; unitQuantity?: number }

Type declaration

PreviewSubscriptionInput

PreviewSubscriptionInput: { addons?: InputMaybe<SubscriptionAddonInput[]>; appliedCoupon?: InputMaybe<SubscriptionCouponInput>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; billingCountryCode?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<SubscriptionBillingInfo>; billingPeriod?: InputMaybe<BillingPeriod>; charges?: InputMaybe<ChargeInput[]>; customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; payingCustomerId?: InputMaybe<Scalars["String"]>; planId: Scalars["String"]; promotionCode?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]>; scheduleStrategy?: InputMaybe<ScheduleStrategy>; startDate?: InputMaybe<Scalars["DateTime"]>; trialOverrideConfiguration?: InputMaybe<TrialOverrideConfigurationInput>; unitQuantity?: InputMaybe<Scalars["Float"]> }

Type declaration

PreviewSubscriptionMutation

PreviewSubscriptionMutation: { __typename?: "Mutation"; previewSubscription: { __typename?: "SubscriptionPreviewV2" } & SubscriptionPreviewV2Fragment }

Type declaration

PreviewSubscriptionMutationVariables

PreviewSubscriptionMutationVariables: Exact<{ input: PreviewSubscriptionInput }>

Price

Price: { amount?: number | null; billingCountryCode?: string | null; billingId?: string | null; billingPeriod: BillingPeriod; blockSize?: number | null; creditRate?: { amount: number } | null; currency: Currency; feature?: { displayName: string; featureId: string; unitQuantity?: number | null; units?: string | null; unitsPlural?: string | null } | null; isTieredPrice: boolean; 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
  • billingPeriod: BillingPeriod
  • Optional blockSize?: number | null
  • Optional creditRate?: { amount: number } | null
  • currency: Currency
  • Optional feature?: { displayName: string; featureId: string; unitQuantity?: number | null; units?: string | null; unitsPlural?: string | null } | null
  • isTieredPrice: boolean
  • Optional maxUnitQuantity?: number | null
  • Optional minUnitQuantity?: number | null
  • pricingModel: BillingModel
  • Optional tiers?: PriceTierFragment[] | null
  • tiersMode: TiersMode | null | undefined

PriceFilter

PriceFilter: { and?: InputMaybe<PriceFilter[]>; billingCadence?: InputMaybe<BillingCadenceFilterComparison>; billingId?: InputMaybe<StringFieldComparison>; billingModel?: InputMaybe<BillingModelFilterComparison>; billingPeriod?: InputMaybe<BillingPeriodFilterComparison>; createdAt?: InputMaybe<DateFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<PriceFilter[]>; package?: InputMaybe<PriceFilterPackageDtoFilter>; tiersMode?: InputMaybe<TiersModeFilterComparison> }

Type declaration

PriceFilterPackageDtoFilter

PriceFilterPackageDtoFilter: { and?: InputMaybe<PriceFilterPackageDtoFilter[]>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<PriceFilterPackageDtoFilter[]>; pricingType?: InputMaybe<PricingTypeFilterComparison>; productId?: InputMaybe<StringFieldComparison>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<PackageStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

PriceFragment

PriceFragment: { __typename?: "Price"; billingCadence: BillingCadence; billingCountryCode?: string | null; billingId?: string | null; billingModel: BillingModel; billingPeriod: BillingPeriod; blockSize?: number | null; creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string; customCurrencyId?: any | null } | null; feature?: { __typename?: "Feature"; description?: string | null; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; refId: string } | null; maxUnitQuantity?: number | null; minUnitQuantity?: number | null; price?: { __typename?: "Money"; amount: number; currency: Currency } | null; tiers?: ({ __typename?: "PriceTier" } & PriceTierFragment)[] | null; tiersMode?: TiersMode | null }

Type declaration

  • Optional __typename?: "Price"
  • billingCadence: BillingCadence
  • Optional billingCountryCode?: string | null
  • Optional billingId?: string | null
  • billingModel: BillingModel
  • billingPeriod: BillingPeriod
  • Optional blockSize?: number | null
  • Optional creditRate?: { __typename?: "CreditRate"; amount: number; currencyId: string; customCurrencyId?: any | null } | null
  • Optional feature?: { __typename?: "Feature"; description?: string | null; displayName: string; featureUnits?: string | null; featureUnitsPlural?: string | null; refId: string } | null
  • Optional maxUnitQuantity?: number | null
  • Optional minUnitQuantity?: number | null
  • Optional price?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional tiers?: ({ __typename?: "PriceTier" } & PriceTierFragment)[] | null
  • Optional tiersMode?: TiersMode | null

PriceOverrideInput

PriceOverrideInput: { addonId?: InputMaybe<Scalars["String"]>; baseCharge?: InputMaybe<Scalars["Boolean"]>; blockSize?: InputMaybe<Scalars["Float"]>; creditGrantCadence?: InputMaybe<CreditGrantCadence>; creditRate?: InputMaybe<CreditRateInput>; featureId?: InputMaybe<Scalars["String"]>; price?: InputMaybe<MoneyInputDto>; tiers?: InputMaybe<PriceTierInput[]> }

Type declaration

PricePeriodInput

PricePeriodInput: { billingCountryCode?: InputMaybe<Scalars["String"]>; billingPeriod: BillingPeriod; blockSize?: InputMaybe<Scalars["Float"]>; creditGrantCadence?: InputMaybe<CreditGrantCadence>; creditRate?: InputMaybe<CreditRateInput>; price?: InputMaybe<MoneyInputDto>; tiers?: InputMaybe<PriceTierInput[]> }

Price Period Input

Type declaration

PriceSort

PriceSort: { direction: SortDirection; field: PriceSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

PriceTierFragment

PriceTierFragment: { __typename?: "PriceTier"; flatPrice?: { __typename?: "Money"; amount: number; currency: Currency } | null; unitPrice?: { __typename?: "Money"; amount: number; currency: Currency } | null; upTo?: number | null }

Type declaration

  • Optional __typename?: "PriceTier"
  • Optional flatPrice?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional unitPrice?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional upTo?: number | null

PriceTierInput

PriceTierInput: { flatPrice?: InputMaybe<MoneyInputDto>; unitPrice?: InputMaybe<MoneyInputDto>; upTo?: InputMaybe<Scalars["Float"]> }

Price Tier Input

Type declaration

PricingModelCreateInput

PricingModelCreateInput: { billingCadence?: InputMaybe<BillingCadence>; billingId?: InputMaybe<Scalars["String"]>; billingModel: BillingModel; featureId?: InputMaybe<Scalars["String"]>; maxUnitQuantity?: InputMaybe<Scalars["Float"]>; minUnitQuantity?: InputMaybe<Scalars["Float"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; pricePeriods: PricePeriodInput[]; resetPeriod?: InputMaybe<EntitlementResetPeriod>; tiersMode?: InputMaybe<TiersMode>; topUpCustomCurrencyId?: InputMaybe<Scalars["String"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Pricing Model Create Input

Type declaration

PricingTypeFilterComparison

PricingTypeFilterComparison: { eq?: InputMaybe<PricingType>; gt?: InputMaybe<PricingType>; gte?: InputMaybe<PricingType>; iLike?: InputMaybe<PricingType>; in?: InputMaybe<PricingType[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<PricingType>; lt?: InputMaybe<PricingType>; lte?: InputMaybe<PricingType>; neq?: InputMaybe<PricingType>; notILike?: InputMaybe<PricingType>; notIn?: InputMaybe<PricingType[]>; notLike?: InputMaybe<PricingType> }

Type declaration

Product

Product: { description?: string | null; displayName?: string | null; id: string; metadata?: Metadata | null }

Type declaration

  • Optional description?: string | null
  • Optional displayName?: string | null
  • id: string
  • Optional metadata?: Metadata | null

ProductCreateInput

ProductCreateInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; environmentId: Scalars["UUID"]; multipleSubscriptions?: InputMaybe<Scalars["Boolean"]>; refId: Scalars["String"] }

Input for creating a product

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Additional metadata for the product

  • Optional description?: InputMaybe<Scalars["String"]>

    Description of the product

  • Optional displayName?: InputMaybe<Scalars["String"]>

    Display name of the product

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • Optional multipleSubscriptions?: InputMaybe<Scalars["Boolean"]>

    Indicates if multiple subscriptions to this product are allowed

  • refId: Scalars["String"]

    The unique identifier for the entity

ProductFilter

ProductFilter: { and?: InputMaybe<ProductFilter[]>; awsMarketplaceProductCode?: InputMaybe<StringFieldComparison>; awsMarketplaceProductId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isDefaultProduct?: InputMaybe<BooleanFieldComparison>; multipleSubscriptions?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<ProductFilter[]>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<ProductStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

ProductFragment

ProductFragment: { __typename?: "Product"; additionalMetaData?: any | null; awsMarketplaceProductId?: string | null; description?: string | null; displayName?: string | null; productSettings: { __typename?: "ProductSettings"; downgradePlan?: { __typename?: "Plan"; displayName: string; refId: string } | null }; refId: string }

Type declaration

  • Optional __typename?: "Product"
  • Optional additionalMetaData?: any | null
  • Optional awsMarketplaceProductId?: string | null
  • Optional description?: string | null
  • Optional displayName?: string | null
  • productSettings: { __typename?: "ProductSettings"; downgradePlan?: { __typename?: "Plan"; displayName: string; refId: string } | null }
    • Optional __typename?: "ProductSettings"
    • Optional downgradePlan?: { __typename?: "Plan"; displayName: string; refId: string } | null
  • refId: string

ProductSettingsInput

ProductSettingsInput: { downgradeAtEndOfBillingPeriod?: InputMaybe<Scalars["String"]>; downgradePlanId?: InputMaybe<Scalars["String"]>; prorateAtEndOfBillingPeriod?: InputMaybe<Scalars["Boolean"]>; subscriptionCancellationTime: SubscriptionCancellationTime; subscriptionEndSetup: SubscriptionEndSetup; subscriptionStartPlanId?: InputMaybe<Scalars["String"]>; subscriptionStartSetup: SubscriptionStartSetup }

Input for product settings

Type declaration

  • Optional downgradeAtEndOfBillingPeriod?: InputMaybe<Scalars["String"]>

    Indicates if the subscription should be downgraded at the end of the billing period

  • Optional downgradePlanId?: InputMaybe<Scalars["String"]>

    ID of the plan to downgrade to at the end of the billing period

  • Optional prorateAtEndOfBillingPeriod?: InputMaybe<Scalars["Boolean"]>

    Indicates if the subscription should be prorated at the end of the billing period

  • subscriptionCancellationTime: SubscriptionCancellationTime

    Time when the subscription will be cancelled

  • subscriptionEndSetup: SubscriptionEndSetup

    Setup for the end of the subscription

  • Optional subscriptionStartPlanId?: InputMaybe<Scalars["String"]>

    ID of the plan to start the subscription with

  • subscriptionStartSetup: SubscriptionStartSetup

    Setup for the start of the subscription

ProductSort

ProductSort: { direction: SortDirection; field: ProductSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

ProductStatusFilterComparison

ProductStatusFilterComparison: { eq?: InputMaybe<ProductStatus>; gt?: InputMaybe<ProductStatus>; gte?: InputMaybe<ProductStatus>; iLike?: InputMaybe<ProductStatus>; in?: InputMaybe<ProductStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<ProductStatus>; lt?: InputMaybe<ProductStatus>; lte?: InputMaybe<ProductStatus>; neq?: InputMaybe<ProductStatus>; notILike?: InputMaybe<ProductStatus>; notIn?: InputMaybe<ProductStatus[]>; notLike?: InputMaybe<ProductStatus> }

Type declaration

ProductUpdateInput

ProductUpdateInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; autoCancellationRules?: InputMaybe<AutoCancellationRuleInput[]>; description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; multipleSubscriptions?: InputMaybe<Scalars["Boolean"]>; productSettings?: InputMaybe<ProductSettingsInput>; usageResetCutoffRule?: InputMaybe<SubscriptionUpdateUsageResetCutoffRuleInput> }

Input for updating a product

Type declaration

PromotionalEntitlement

PromotionalEntitlement: { expiresAt?: Date; feature: EntitlementFeature; hasExpirationDate: boolean; hasUnlimitedUsage?: boolean | null; isVisible: boolean; status: PromotionalEntitlementStatus; usageLimit: number }

Type declaration

PromotionalEntitlementFilter

PromotionalEntitlementFilter: { and?: InputMaybe<PromotionalEntitlementFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<PromotionalEntitlementFilter[]>; status?: InputMaybe<PromotionalEntitlementStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

PromotionalEntitlementFragment

PromotionalEntitlementFragment: { __typename?: "PromotionalEntitlement"; endDate?: any | null; feature: { __typename?: "Feature"; additionalMetaData?: any | null; description?: string | null; displayName: string; featureType: FeatureType; featureUnits?: string | null; featureUnitsPlural?: string | null; meterType?: MeterType | null; refId: string }; featureId: any; hasSoftLimit?: boolean | null; hasUnlimitedUsage?: boolean | null; isVisible: boolean; resetPeriod?: EntitlementResetPeriod | null; status: PromotionalEntitlementStatus; usageLimit?: number | null }

Type declaration

  • Optional __typename?: "PromotionalEntitlement"
  • Optional endDate?: any | null
  • feature: { __typename?: "Feature"; additionalMetaData?: any | null; description?: string | null; displayName: string; featureType: FeatureType; featureUnits?: string | null; featureUnitsPlural?: string | null; meterType?: MeterType | null; refId: string }
    • Optional __typename?: "Feature"
    • Optional additionalMetaData?: any | null
    • Optional description?: string | null
    • displayName: string
    • featureType: FeatureType
    • Optional featureUnits?: string | null
    • Optional featureUnitsPlural?: string | null
    • Optional meterType?: MeterType | null
    • refId: string
  • featureId: any
  • Optional hasSoftLimit?: boolean | null
  • Optional hasUnlimitedUsage?: boolean | null
  • isVisible: boolean
  • Optional resetPeriod?: EntitlementResetPeriod | null
  • status: PromotionalEntitlementStatus
  • Optional usageLimit?: number | null

PromotionalEntitlementInput

PromotionalEntitlementInput: { customerId: Scalars["String"]; description?: InputMaybe<Scalars["String"]>; endDate?: InputMaybe<Scalars["DateTime"]>; enumValues?: InputMaybe<Scalars["String"][]>; environmentId: Scalars["UUID"]; featureGroupId?: InputMaybe<Scalars["UUID"]>; featureId: Scalars["String"]; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; isVisible: Scalars["Boolean"]; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; period: PromotionalEntitlementPeriod; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Promotional entitlement input

Type declaration

  • customerId: Scalars["String"]

    The unique identifier of the entitlement customer

  • Optional description?: InputMaybe<Scalars["String"]>

    The description of the entitlement

  • Optional endDate?: InputMaybe<Scalars["DateTime"]>

    The end date of the promotional entitlement

  • Optional enumValues?: InputMaybe<Scalars["String"][]>

    The enum values of the entitlement

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • Optional featureGroupId?: InputMaybe<Scalars["UUID"]>

    Primary feature group ID (first in the array) associated with this entitlement

  • featureId: Scalars["String"]

    The unique identifier of the entitlement feature

  • Optional hasSoftLimit?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has a soft limit

  • Optional hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has an unlimited usage

  • isVisible: Scalars["Boolean"]

    Whether the entitlement is visible

  • Optional monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>

    The monthly reset period configuration of the entitlement, defined when reset period is monthly

  • period: PromotionalEntitlementPeriod

    The grant period of the promotional entitlement

  • Optional resetPeriod?: InputMaybe<EntitlementResetPeriod>

    The reset period of the entitlement

  • Optional usageLimit?: InputMaybe<Scalars["Float"]>

    The usage limit of the entitlement

  • Optional weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>

    The weekly reset period configuration of the entitlement, defined when reset period is weekly

  • Optional yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>

    The yearly reset period configuration of the entitlement, defined when reset period is yearly

PromotionalEntitlementSort

PromotionalEntitlementSort: { direction: SortDirection; field: PromotionalEntitlementSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

PromotionalEntitlementStatusFilterComparison

PromotionalEntitlementStatusFilterComparison: { eq?: InputMaybe<PromotionalEntitlementStatus>; gt?: InputMaybe<PromotionalEntitlementStatus>; gte?: InputMaybe<PromotionalEntitlementStatus>; iLike?: InputMaybe<PromotionalEntitlementStatus>; in?: InputMaybe<PromotionalEntitlementStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<PromotionalEntitlementStatus>; lt?: InputMaybe<PromotionalEntitlementStatus>; lte?: InputMaybe<PromotionalEntitlementStatus>; neq?: InputMaybe<PromotionalEntitlementStatus>; notILike?: InputMaybe<PromotionalEntitlementStatus>; notIn?: InputMaybe<PromotionalEntitlementStatus[]>; notLike?: InputMaybe<PromotionalEntitlementStatus> }

Type declaration

PromotionalEntitlementUpdateInput

PromotionalEntitlementUpdateInput: { description?: InputMaybe<Scalars["String"]>; endDate?: InputMaybe<Scalars["DateTime"]>; enumValues?: InputMaybe<Scalars["String"][]>; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; isVisible: Scalars["Boolean"]; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; period: PromotionalEntitlementPeriod; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput> }

Promotional entitlement update input

Type declaration

ProvisionCustomerFragment

ProvisionCustomerFragment: { __typename?: "ProvisionedCustomer"; customer: { __typename?: "Customer" } & SlimCustomerFragment; entitlements?: ({ __typename?: "Entitlement" } & EntitlementFragment)[] | null; subscription?: ({ __typename?: "CustomerSubscription" } & SlimSubscriptionFragment) | null; subscriptionDecisionStrategy: SubscriptionDecisionStrategy }

Type declaration

ProvisionCustomerInput

ProvisionCustomerInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; awsMarketplaceCustomerId?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<CustomerBillingInfo>; couponRefId?: InputMaybe<Scalars["String"]>; createdAt?: InputMaybe<Scalars["DateTime"]>; crmId?: InputMaybe<Scalars["String"]>; customerId?: InputMaybe<Scalars["String"]>; email?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; excludeFromExperiment?: InputMaybe<Scalars["Boolean"]>; name?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; shouldSyncFree?: InputMaybe<Scalars["Boolean"]>; subscriptionParams?: InputMaybe<ProvisionCustomerSubscriptionInput> }

Input to provision a customer and subscription

Type declaration

ProvisionCustomerMutation

ProvisionCustomerMutation: { __typename?: "Mutation"; provisionCustomer: { __typename?: "ProvisionedCustomer" } & ProvisionCustomerFragment }

Type declaration

ProvisionCustomerMutationVariables

ProvisionCustomerMutationVariables: Exact<{ input: ProvisionCustomerInput }>

ProvisionCustomerSubscriptionInput

ProvisionCustomerSubscriptionInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; addons?: InputMaybe<SubscriptionAddonInput[]>; appliedCoupon?: InputMaybe<SubscriptionCouponInput>; awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; billingCountryCode?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<SubscriptionBillingInfo>; billingPeriod?: InputMaybe<BillingPeriod>; budget?: InputMaybe<BudgetConfigurationInput>; charges?: InputMaybe<ChargeInput[]>; minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>; paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>; planId: Scalars["String"]; priceOverrides?: InputMaybe<PriceOverrideInput[]>; priceUnitAmount?: InputMaybe<Scalars["Float"]>; promotionCode?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; startDate?: InputMaybe<Scalars["DateTime"]>; subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>; subscriptionId?: InputMaybe<Scalars["String"]>; trialOverrideConfiguration?: InputMaybe<TrialOverrideConfigurationInput>; unitQuantity?: InputMaybe<Scalars["Float"]> }

Provision a new subscription for a customer

Type declaration

ProvisionSandboxInput

ProvisionSandboxInput: { billingModel: BillingModel; displayName: Scalars["String"] }

Input for provisioning a sandbox environment

Type declaration

  • billingModel: BillingModel

    The billing model to use for the sandbox environment

  • displayName: Scalars["String"]

    The name of the sandbox environment

ProvisionSubscription

ProvisionSubscription: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; addons?: InputMaybe<SubscriptionAddonInput[]>; appliedCoupon?: InputMaybe<SubscriptionCouponInput>; awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; billingCountryCode?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<SubscriptionBillingInfo>; billingPeriod?: InputMaybe<BillingPeriod>; budget?: InputMaybe<BudgetConfigurationInput>; charges?: InputMaybe<ChargeInput[]>; checkoutOptions?: InputMaybe<CheckoutOptions>; customerId: Scalars["String"]; minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>; payingCustomerId?: InputMaybe<Scalars["String"]>; paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>; planId: Scalars["String"]; priceOverrides?: InputMaybe<PriceOverrideInput[]>; priceUnitAmount?: InputMaybe<Scalars["Float"]>; promotionCode?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; scheduleStrategy?: InputMaybe<ScheduleStrategy>; skipTrial?: InputMaybe<Scalars["Boolean"]>; startDate?: InputMaybe<Scalars["DateTime"]>; subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>; subscriptionId?: InputMaybe<Scalars["String"]>; trialOverrideConfiguration?: InputMaybe<TrialOverrideConfigurationInput>; unitQuantity?: InputMaybe<Scalars["Float"]> }

Type declaration

ProvisionSubscriptionFragment

ProvisionSubscriptionFragment: { __typename?: "ProvisionSubscriptionResult"; checkoutBillingId?: string | null; checkoutUrl?: string | null; entitlements?: ({ __typename?: "Entitlement" } & EntitlementFragment)[] | null; status: ProvisionSubscriptionStatus; subscription?: ({ __typename?: "CustomerSubscription" } & SlimSubscriptionFragment) | null }

Type declaration

  • Optional __typename?: "ProvisionSubscriptionResult"
  • Optional checkoutBillingId?: string | null
  • Optional checkoutUrl?: string | null
  • Optional entitlements?: ({ __typename?: "Entitlement" } & EntitlementFragment)[] | null
  • status: ProvisionSubscriptionStatus
  • Optional subscription?: ({ __typename?: "CustomerSubscription" } & SlimSubscriptionFragment) | null

ProvisionSubscriptionInput

ProvisionSubscriptionInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; addons?: InputMaybe<SubscriptionAddonInput[]>; appliedCoupon?: InputMaybe<SubscriptionCouponInput>; awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; billingCountryCode?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<SubscriptionBillingInfo>; billingPeriod?: InputMaybe<BillingPeriod>; budget?: InputMaybe<BudgetConfigurationInput>; charges?: InputMaybe<ChargeInput[]>; checkoutOptions?: InputMaybe<CheckoutOptions>; customerId: Scalars["String"]; minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>; payingCustomerId?: InputMaybe<Scalars["String"]>; paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>; planId: Scalars["String"]; priceOverrides?: InputMaybe<PriceOverrideInput[]>; priceUnitAmount?: InputMaybe<Scalars["Float"]>; promotionCode?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; scheduleStrategy?: InputMaybe<ScheduleStrategy>; skipTrial?: InputMaybe<Scalars["Boolean"]>; startDate?: InputMaybe<Scalars["DateTime"]>; subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>; subscriptionId?: InputMaybe<Scalars["String"]>; trialOverrideConfiguration?: InputMaybe<TrialOverrideConfigurationInput>; unitQuantity?: InputMaybe<Scalars["Float"]> }

Type declaration

ProvisionSubscriptionMutation

ProvisionSubscriptionMutation: { __typename?: "Mutation"; provisionSubscription: { __typename?: "ProvisionSubscriptionResult" } & ProvisionSubscriptionFragment }

Type declaration

ProvisionSubscriptionMutationVariables

ProvisionSubscriptionMutationVariables: Exact<{ input: ProvisionSubscriptionInput }>

PublishOfferInput

PublishOfferInput: { environmentId: Scalars["UUID"]; offerId: Scalars["String"] }

Publish offer input

Type declaration

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • offerId: Scalars["String"]

    The unique identifier for the entity

RecalculateEntitlementsInput

RecalculateEntitlementsInput: { customerIds?: InputMaybe<Scalars["String"][]>; environmentId: Scalars["UUID"]; forAllCustomers?: InputMaybe<Scalars["Boolean"]>; sideEffectsOptions?: InputMaybe<RecalculateEntitlementsSideEffectsOptionsInput> }

Input object for triggering entitlement recalculation for one or more customers.

Type declaration

RecalculateEntitlementsSideEffectsOptionsInput

RecalculateEntitlementsSideEffectsOptionsInput: { skipPublishToSubscribers?: InputMaybe<Scalars["Boolean"]>; skipWriteToCache?: InputMaybe<Scalars["Boolean"]>; skipWriteToDataCatalog?: InputMaybe<Scalars["Boolean"]>; skipWriteToEventLog?: InputMaybe<Scalars["Boolean"]> }

Flags to control side effects triggered during entitlement recalculation.

Type declaration

  • Optional skipPublishToSubscribers?: InputMaybe<Scalars["Boolean"]>

    Prevents publishing entitlement updates to subscribers.

  • Optional skipWriteToCache?: InputMaybe<Scalars["Boolean"]>

    Skips cache updates for recalculated entitlements.

  • Optional skipWriteToDataCatalog?: InputMaybe<Scalars["Boolean"]>

    Skips updating the data catalog during recalculation.

  • Optional skipWriteToEventLog?: InputMaybe<Scalars["Boolean"]>

    Skips writing entitlement recalculation events to the event log.

RemoveBasePlanFromPlanInput

RemoveBasePlanFromPlanInput: { id: Scalars["UUID"]; relationId: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationId: Scalars["UUID"]

    The id of relation.

RemoveCompatibleAddonsFromPlanInput

RemoveCompatibleAddonsFromPlanInput: { id: Scalars["UUID"]; relationIds: Scalars["UUID"][] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationIds: Scalars["UUID"][]

    The ids of the relations.

RemoveCouponFromCustomerInput

RemoveCouponFromCustomerInput: { id: Scalars["UUID"]; relationId: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationId: Scalars["UUID"]

    The id of relation.

RemoveExperimentFromCustomerInput

RemoveExperimentFromCustomerInput: { id: Scalars["UUID"]; relationId: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationId: Scalars["UUID"]

    The id of relation.

RemoveExperimentFromCustomerSubscriptionInput

RemoveExperimentFromCustomerSubscriptionInput: { id: Scalars["UUID"]; relationId: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationId: Scalars["UUID"]

    The id of relation.

RemoveFeatureGroupFromPackageInput

RemoveFeatureGroupFromPackageInput: { environmentId?: InputMaybe<Scalars["UUID"]>; featureGroupId: Scalars["UUID"]; packageId: Scalars["UUID"] }

Input for removing a feature group and his related entitlements (if there are no other groups they are a part of) from a package

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureGroupId: Scalars["UUID"]

    The group id to remove

  • packageId: Scalars["UUID"]

    The unique identifier of the entitlement package

RemoveOfferDraftInput

RemoveOfferDraftInput: { environmentId: Scalars["UUID"]; offerId: Scalars["String"] }

Remove offer draft input

Type declaration

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • offerId: Scalars["String"]

    The unique identifier for the entity

ReportEntitlementCheckRequestedMutation

ReportEntitlementCheckRequestedMutation: { __typename?: "Mutation"; reportEntitlementCheckRequested: boolean }

Type declaration

  • Optional __typename?: "Mutation"
  • reportEntitlementCheckRequested: boolean

ReportEntitlementCheckRequestedMutationVariables

ReportEntitlementCheckRequestedMutationVariables: Exact<{ entitlementCheckRequested: EntitlementCheckRequested }>

ReportEventMutation

ReportEventMutation: { __typename?: "Mutation"; reportEvent?: string | null }

Type declaration

  • Optional __typename?: "Mutation"
  • Optional reportEvent?: string | null

ReportEventMutationVariables

ReportEventMutationVariables: Exact<{ input: UsageEventsReportInput }>

ReportUsageBaseInput

ReportUsageBaseInput: { createdAt?: InputMaybe<Scalars["DateTime"]>; customerId: Scalars["String"]; dimensions?: InputMaybe<Scalars["JSON"]>; featureId: Scalars["String"]; resourceId?: InputMaybe<Scalars["String"]>; updateBehavior?: InputMaybe<UsageUpdateBehavior>; value: Scalars["Float"] }

Report usage base input

Type declaration

ReportUsageBulkInput

ReportUsageBulkInput: { environmentId?: InputMaybe<Scalars["UUID"]>; usages: ReportUsageBaseInput[] }

Input for reporting usage in bulk

Type declaration

ReportUsageBulkMutation

ReportUsageBulkMutation: { __typename?: "Mutation"; reportUsageBulk: ({ __typename?: "UsageMeasurementWithCurrentUsage" } & ReportUsageFragment)[] }

Type declaration

  • Optional __typename?: "Mutation"
  • reportUsageBulk: ({ __typename?: "UsageMeasurementWithCurrentUsage" } & ReportUsageFragment)[]

ReportUsageBulkMutationVariables

ReportUsageBulkMutationVariables: Exact<{ input: ReportUsageBulkInput }>

ReportUsageFragment

ReportUsageFragment: { __typename?: "UsageMeasurementWithCurrentUsage"; currentUsage?: number | null; customerId: string; featureId: string; id: any; nextResetDate?: any | null; resourceId?: string | null; timestamp: any; usagePeriodEnd?: any | null; usagePeriodStart?: any | null }

Type declaration

  • Optional __typename?: "UsageMeasurementWithCurrentUsage"
  • Optional currentUsage?: number | null
  • customerId: string
  • featureId: string
  • id: any
  • Optional nextResetDate?: any | null
  • Optional resourceId?: string | null
  • timestamp: any
  • Optional usagePeriodEnd?: any | null
  • Optional usagePeriodStart?: any | null

ReportUsageInput

ReportUsageInput: { createdAt?: InputMaybe<Scalars["DateTime"]>; customerId: Scalars["String"]; dimensions?: InputMaybe<Scalars["JSON"]>; environmentId?: InputMaybe<Scalars["UUID"]>; featureId: Scalars["String"]; resourceId?: InputMaybe<Scalars["String"]>; updateBehavior?: InputMaybe<UsageUpdateBehavior>; value: Scalars["Float"] }

Input parameters for reporting usage

Type declaration

  • Optional createdAt?: InputMaybe<Scalars["DateTime"]>

    Timestamp of when the record was created

  • customerId: Scalars["String"]

    Customer id

  • Optional dimensions?: InputMaybe<Scalars["JSON"]>

    Additional dimensions for the usage report

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureId: Scalars["String"]

    Feature id

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    Resource id

  • Optional updateBehavior?: InputMaybe<UsageUpdateBehavior>

    The method by which the usage value should be updated

  • value: Scalars["Float"]

    The value to report for usage

ReportUsageMutation

ReportUsageMutation: { __typename?: "Mutation"; reportUsage: { __typename?: "UsageMeasurementWithCurrentUsage" } & ReportUsageFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • reportUsage: { __typename?: "UsageMeasurementWithCurrentUsage" } & ReportUsageFragment

ReportUsageMutationVariables

ReportUsageMutationVariables: Exact<{ input: ReportUsageInput }>

ResetPeriodConfigurationFragment

ResetPeriodConfigurationFragment: ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ | ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_ | ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_

ResetSettings

ResetSettings: { nextResetDate: Date; resetPeriod: EntitlementResetPeriod }
deprecated

Type declaration

ResyncIntegrationInput

ResyncIntegrationInput: { environmentId: Scalars["String"]; integrationId: Scalars["String"]; recalculateEntitlements?: InputMaybe<Scalars["Boolean"]>; vendorIdentifier?: InputMaybe<VendorIdentifier> }

Input for re-syncing an integration

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • integrationId: Scalars["String"]

    Internal ID of the integration to re-sync

  • Optional recalculateEntitlements?: InputMaybe<Scalars["Boolean"]>

    Allow skipping entitlement recalculation

  • Optional vendorIdentifier?: InputMaybe<VendorIdentifier>

    The vendor identifier of integration

RevokePromotionalEntitlementInput

RevokePromotionalEntitlementInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; featureId: Scalars["String"] }

Revoke promotional entitlement input

Type declaration

  • customerId: Scalars["String"]

    The unique identifier of the entitlement customer

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureId: Scalars["String"]

    The unique identifier of the entitlement feature

RevokePromotionalEntitlementMutation

RevokePromotionalEntitlementMutation: { __typename?: "Mutation"; revokePromotionalEntitlement: { __typename?: "PromotionalEntitlement"; id: any } }

Type declaration

  • Optional __typename?: "Mutation"
  • revokePromotionalEntitlement: { __typename?: "PromotionalEntitlement"; id: any }
    • Optional __typename?: "PromotionalEntitlement"
    • id: any

RevokePromotionalEntitlementMutationVariables

RevokePromotionalEntitlementMutationVariables: Exact<{ input: RevokePromotionalEntitlementInput }>

RevokePromotionalEntitlementsGroupInput

RevokePromotionalEntitlementsGroupInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; featureGroupId: Scalars["String"] }

Revoke promotional entitlements for a feature group input

Type declaration

  • customerId: Scalars["String"]

    The unique identifier of the entitlement customer

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureGroupId: Scalars["String"]

    Feature group ID to revoke from promotional entitlements

RevokePromotionalEntitlementsGroupMutation

RevokePromotionalEntitlementsGroupMutation: { __typename?: "Mutation"; revokePromotionalEntitlementsGroup: ({ __typename?: "PromotionalEntitlement" } & PromotionalEntitlementFragment)[] }

Type declaration

RevokePromotionalEntitlementsGroupMutationVariables

RevokePromotionalEntitlementsGroupMutationVariables: Exact<{ input: RevokePromotionalEntitlementsGroupInput }>

RollbackPackageInput

RollbackPackageInput: { environmentId: Scalars["String"]; refId: Scalars["String"]; versionNumber: Scalars["Int"] }

Rollback Package Input

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • refId: Scalars["String"]

    The unique identifier for the entity

  • versionNumber: Scalars["Int"]

    The version number to rollback to

SalesforceCredentialsInput

SalesforceCredentialsInput: { domain?: InputMaybe<Scalars["String"]> }

Input configuration for Salesforce Integration

Type declaration

SaveAutoRechargeSettingsInput

SaveAutoRechargeSettingsInput: { currencyId: Scalars["String"]; customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["String"]>; grantExpirationPeriod?: InputMaybe<GrantExpirationPeriod>; isEnabled: Scalars["Boolean"]; maxSpendLimit?: InputMaybe<Scalars["Float"]>; targetBalance?: InputMaybe<Scalars["Float"]>; thresholdType?: InputMaybe<ThresholdType>; thresholdValue?: InputMaybe<Scalars["Float"]> }

Input for saving auto-recharge settings

Type declaration

SaveAutomaticRechargeConfigurationInput

SaveAutomaticRechargeConfigurationInput: SaveAutoRechargeSettingsInput

SaveAutomaticRechargeConfigurationMutation

SaveAutomaticRechargeConfigurationMutation: { __typename?: "Mutation"; saveAutoRechargeSettings: { __typename?: "AutoRechargeSettingsDTO" } & AutoRechargeSettingsFragment }

Type declaration

SaveAutomaticRechargeConfigurationMutationVariables

SaveAutomaticRechargeConfigurationMutationVariables: Exact<{ input: SaveAutoRechargeSettingsInput }>

Scalars

Scalars: { Boolean: boolean; ConnectionCursor: any; DateTime: any; Float: number; ID: string; Int: number; JSON: any; String: string; UUID: any }

All built-in and custom scalars, mapped to their actual values

Type declaration

  • Boolean: boolean
  • ConnectionCursor: any

    Cursor for paging through collections

  • DateTime: any

    A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

  • Float: number
  • ID: string
  • Int: number
  • JSON: any

    The JSON scalar type represents JSON values as specified by ECMA-404.

  • String: string
  • UUID: any

    A field whose value is a generic Universally Unique Identifier: https://en.wikipedia.org/wiki/Universally_unique_identifier.

ScheduleVariablesFragment

ScheduleVariablesFragment: ScheduleVariablesFragment_AddonChangeVariables_ | ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_ | ScheduleVariablesFragment_BillingPeriodChangeVariables_ | ScheduleVariablesFragment_CouponChangeVariables_ | ScheduleVariablesFragment_DowngradeChangeVariables_ | ScheduleVariablesFragment_PlanChangeVariables_ | ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_ | ScheduleVariablesFragment_RecurringCreditsChangeVariables_ | ScheduleVariablesFragment_UnitAmountChangeVariables_

Sdk

Sdk: ReturnType<typeof getSdk>

SdkFunctionWrapper

SdkFunctionWrapper: <T>(action: (requestHeaders?: Record<string, string>) => Promise<T>, operationName: string, operationType?: string) => Promise<T>

Type declaration

    • <T>(action: (requestHeaders?: Record<string, string>) => Promise<T>, operationName: string, operationType?: string): Promise<T>

    • Type parameters

      • T

      Parameters

      • action: (requestHeaders?: Record<string, string>) => Promise<T>
          • (requestHeaders?: Record<string, string>): Promise<T>

          • Parameters

            • Optional requestHeaders: Record<string, string>

            Returns Promise<T>

      • operationName: string
      • Optional operationType: string

      Returns Promise<T>

SetAccessRolesInput

SetAccessRolesInput: { accountRole: AccountAccessRole; nonProductionRole: EnvironmentAccessRole; productionRole: EnvironmentAccessRole; userId: Scalars["String"] }

Input for setting access roles for a user

Type declaration

SetBasePlanOnPlanInput

SetBasePlanOnPlanInput: { id: Scalars["UUID"]; relationId: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationId: Scalars["UUID"]

    The id of relation.

SetCompatibleAddonsOnPlanInput

SetCompatibleAddonsOnPlanInput: { id: Scalars["UUID"]; relationIds: Scalars["UUID"][] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationIds: Scalars["UUID"][]

    The ids of the relations.

SetCouponOnCustomerInput

SetCouponOnCustomerInput: { id: Scalars["UUID"]; relationId: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationId: Scalars["UUID"]

    The id of relation.

SetDefaultOfferInput

SetDefaultOfferInput: { environmentId?: InputMaybe<Scalars["UUID"]>; offerId: Scalars["String"] }

Set default offer input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • offerId: Scalars["String"]

    The unique identifier for the entity

SetExperimentOnCustomerInput

SetExperimentOnCustomerInput: { id: Scalars["UUID"]; relationId: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationId: Scalars["UUID"]

    The id of relation.

SetExperimentOnCustomerSubscriptionInput

SetExperimentOnCustomerSubscriptionInput: { id: Scalars["UUID"]; relationId: Scalars["UUID"] }

Type declaration

  • id: Scalars["UUID"]

    The id of the record.

  • relationId: Scalars["UUID"]

    The id of relation.

SetPackageGroupAddons

SetPackageGroupAddons: { addons: Scalars["String"][]; environmentId?: InputMaybe<Scalars["UUID"]>; packageGroupId: Scalars["String"] }

The input type for setting the addons of an package group

Type declaration

  • addons: Scalars["String"][]

    The addons to set on the package group

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • packageGroupId: Scalars["String"]

    The id of the package group

SetPlanCompatiblePackageGroup

SetPlanCompatiblePackageGroup: { options?: InputMaybe<SetPlanCompatiblePackageGroupOptions>; packageGroupId: Scalars["String"] }

Set plan compatible package groups input

Type declaration

SetPlanCompatiblePackageGroupOptions

SetPlanCompatiblePackageGroupOptions: { freeItems?: InputMaybe<Scalars["Float"]>; minItems?: InputMaybe<Scalars["Float"]> }

Set plan compatible package groups input

Type declaration

  • Optional freeItems?: InputMaybe<Scalars["Float"]>

    Number of free items from packageGroup

  • Optional minItems?: InputMaybe<Scalars["Float"]>

    Number of required items from packageGroup

SetPlanCompatiblePackageGroups

SetPlanCompatiblePackageGroups: { environmentId?: InputMaybe<Scalars["UUID"]>; id: Scalars["String"]; packageGroups: SetPlanCompatiblePackageGroup[] }

Set plan compatible package groups input

Type declaration

SlimCustomCurrencyFragment

SlimCustomCurrencyFragment: { __typename?: "SlimCustomCurrency"; currencyId: string; displayName: string; units?: { __typename?: "Units"; plural: string; singular: string } | null }

Type declaration

  • Optional __typename?: "SlimCustomCurrency"
  • currencyId: string
  • displayName: string
  • Optional units?: { __typename?: "Units"; plural: string; singular: string } | null

SlimCustomer

SlimCustomer: { awsMarketplaceCustomerId?: string | null; billingId?: string; createdAt: Date; email?: string; id: string; metadata?: Metadata | null; name?: string; updatedAt: Date }

Type declaration

  • Optional awsMarketplaceCustomerId?: string | null
  • Optional billingId?: string
  • createdAt: Date
  • Optional email?: string
  • id: string
  • Optional metadata?: Metadata | null
  • Optional name?: string
  • updatedAt: Date

SlimCustomerFragment

SlimCustomerFragment: { __typename?: "Customer"; additionalMetaData?: any | null; awsMarketplaceCustomerId?: string | null; billingId?: string | null; createdAt?: any | null; customerId: string; email?: string | null; id: any; name?: string | null; refId: string; updatedAt: any }

Type declaration

  • Optional __typename?: "Customer"
  • Optional additionalMetaData?: any | null
  • Optional awsMarketplaceCustomerId?: string | null
  • Optional billingId?: string | null
  • Optional createdAt?: any | null
  • customerId: string
  • Optional email?: string | null
  • id: any
  • Optional name?: string | null
  • refId: string
  • updatedAt: any

SlimSubscriptionFragment

SlimSubscriptionFragment: { __typename?: "CustomerSubscription"; additionalMetaData?: any | null; addons?: { __typename?: "SubscriptionAddon"; addon: { __typename?: "Addon"; id: any; refId: string }; quantity: number }[] | null; billingId?: string | null; billingLinkUrl?: string | null; billingSyncError?: string | null; cancellationDate?: any | null; currentBillingPeriodEnd?: any | null; customer: { __typename?: "Customer"; id: any; refId: string }; effectiveEndDate?: any | null; experimentInfo?: { __typename?: "experimentInfo"; groupName: string; groupType: ExperimentGroupType; id: string; name: string } | null; id: any; latestInvoice?: ({ __typename?: "SubscriptionInvoice" } & SubscriptionInvoiceFragment) | null; paymentCollection: PaymentCollection; plan: { __typename?: "Plan"; id: any; refId: string }; prices?: { __typename?: "SubscriptionPrice"; price?: ({ __typename?: "Price" } & PriceFragment) | null; usageLimit?: number | null }[] | null; pricingType: PricingType; refId: string; resource?: ({ __typename?: "CustomerResource" } & CustomerResourceFragment) | null; status: SubscriptionStatus; subscriptionId: string; totalPrice?: ({ __typename?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment) | null }

Type declaration

  • Optional __typename?: "CustomerSubscription"
  • Optional additionalMetaData?: any | null
  • Optional addons?: { __typename?: "SubscriptionAddon"; addon: { __typename?: "Addon"; id: any; refId: string }; quantity: number }[] | null
  • Optional billingId?: string | null
  • Optional billingLinkUrl?: string | null
  • Optional billingSyncError?: string | null
  • Optional cancellationDate?: any | null
  • Optional currentBillingPeriodEnd?: any | null
  • customer: { __typename?: "Customer"; id: any; refId: string }
    • Optional __typename?: "Customer"
    • id: any
    • refId: string
  • Optional effectiveEndDate?: any | null
  • Optional experimentInfo?: { __typename?: "experimentInfo"; groupName: string; groupType: ExperimentGroupType; id: string; name: string } | null
  • id: any
  • Optional latestInvoice?: ({ __typename?: "SubscriptionInvoice" } & SubscriptionInvoiceFragment) | null
  • paymentCollection: PaymentCollection
  • plan: { __typename?: "Plan"; id: any; refId: string }
    • Optional __typename?: "Plan"
    • id: any
    • refId: string
  • Optional prices?: { __typename?: "SubscriptionPrice"; price?: ({ __typename?: "Price" } & PriceFragment) | null; usageLimit?: number | null }[] | null
  • pricingType: PricingType
  • refId: string
  • Optional resource?: ({ __typename?: "CustomerResource" } & CustomerResourceFragment) | null
  • status: SubscriptionStatus
  • subscriptionId: string
  • Optional totalPrice?: ({ __typename?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment) | null

SlimSubscriptionFragmentV2Fragment

SlimSubscriptionFragmentV2Fragment: { __typename?: "CustomerSubscription"; additionalMetaData?: any | null; addons?: { __typename?: "SubscriptionAddon"; addon: { __typename?: "Addon"; addonId: string }; quantity: number }[] | null; cancellationDate?: any | null; currentBillingPeriodEnd?: any | null; customer: { __typename?: "Customer"; customerId: string; email?: string | null }; effectiveEndDate?: any | null; endDate?: any | null; payingCustomer?: { __typename?: "Customer"; customerId: string; email?: string | null } | null; plan: { __typename?: "Plan"; displayName: string; planId: string }; prices?: { __typename?: "SubscriptionPrice"; billingModel?: BillingModel | null; price?: { __typename?: "Price"; billingPeriod: BillingPeriod; price?: { __typename?: "Money"; amount: number; currency: Currency } | null } | null }[] | null; pricingType: PricingType; resource?: { __typename?: "CustomerResource"; resourceId: string } | null; startDate: any; status: SubscriptionStatus; subscriptionId: string; trialConfiguration?: { __typename?: "TrialConfiguration"; trialEndBehavior: TrialEndBehavior } | null; trialEndDate?: any | null }

Type declaration

  • Optional __typename?: "CustomerSubscription"
  • Optional additionalMetaData?: any | null
  • Optional addons?: { __typename?: "SubscriptionAddon"; addon: { __typename?: "Addon"; addonId: string }; quantity: number }[] | null
  • Optional cancellationDate?: any | null
  • Optional currentBillingPeriodEnd?: any | null
  • customer: { __typename?: "Customer"; customerId: string; email?: string | null }
    • Optional __typename?: "Customer"
    • customerId: string
    • Optional email?: string | null
  • Optional effectiveEndDate?: any | null
  • Optional endDate?: any | null
  • Optional payingCustomer?: { __typename?: "Customer"; customerId: string; email?: string | null } | null
  • plan: { __typename?: "Plan"; displayName: string; planId: string }
    • Optional __typename?: "Plan"
    • displayName: string
    • planId: string
  • Optional prices?: { __typename?: "SubscriptionPrice"; billingModel?: BillingModel | null; price?: { __typename?: "Price"; billingPeriod: BillingPeriod; price?: { __typename?: "Money"; amount: number; currency: Currency } | null } | null }[] | null
  • pricingType: PricingType
  • Optional resource?: { __typename?: "CustomerResource"; resourceId: string } | null
  • startDate: any
  • status: SubscriptionStatus
  • subscriptionId: string
  • Optional trialConfiguration?: { __typename?: "TrialConfiguration"; trialEndBehavior: TrialEndBehavior } | null
  • Optional trialEndDate?: any | null

SnowflakeCredentialsInput

SnowflakeCredentialsInput: { database: Scalars["String"]; host: Scalars["String"]; passphrase?: InputMaybe<Scalars["String"]>; password?: InputMaybe<Scalars["String"]>; privateKey?: InputMaybe<Scalars["String"]>; role: Scalars["String"]; schemaName: Scalars["String"]; username: Scalars["String"]; warehouse: Scalars["String"] }

Input configuration for Snowflake integration

Type declaration

  • database: Scalars["String"]

    The database you specified when creating the Stigg entities in Snowflake, for example: STIGG_DATABASE

  • host: Scalars["String"]

    The Snowflake account URL, for example: https://ab12345.us-east-2.aws.snowflakecomputing.com

  • Optional passphrase?: InputMaybe<Scalars["String"]>

    The passphrase for the encrypted private key

  • Optional password?: InputMaybe<Scalars["String"]>

    The password you specified when creating the Stigg entities in Snowflake

  • Optional privateKey?: InputMaybe<Scalars["String"]>

    The private key pair to public key specified when creating the Stigg entities in Snowflake

  • role: Scalars["String"]

    The role you specified when creating the Stigg entities in Snowflake, for example: STIGG_ROLE

  • schemaName: Scalars["String"]

    The schema you specified when creating the Stigg entities in Snowflake, for example: STIGG_SCHEMA

  • username: Scalars["String"]

    The username you specified when creating the Stigg entities in Snowflake, for example: STIGG_USER

  • warehouse: Scalars["String"]

    The warehouse you specified when creating the Stigg entities in Snowflake, for example: STIGG_WAREHOUSE

StartExperimentInput

StartExperimentInput: { environmentId?: InputMaybe<Scalars["UUID"]>; refId: Scalars["String"] }

Input parameters for starting an experiment

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • refId: Scalars["String"]

    The unique identifier for the experiment

StopExperimentInput

StopExperimentInput: { environmentId?: InputMaybe<Scalars["UUID"]>; refId: Scalars["String"] }

Input parameters for stopping an experiment

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • refId: Scalars["String"]

    The unique identifier for the experiment

StringFieldComparison

StringFieldComparison: { eq?: InputMaybe<Scalars["String"]>; gt?: InputMaybe<Scalars["String"]>; gte?: InputMaybe<Scalars["String"]>; iLike?: InputMaybe<Scalars["String"]>; in?: InputMaybe<Scalars["String"][]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<Scalars["String"]>; lt?: InputMaybe<Scalars["String"]>; lte?: InputMaybe<Scalars["String"]>; neq?: InputMaybe<Scalars["String"]>; notILike?: InputMaybe<Scalars["String"]>; notIn?: InputMaybe<Scalars["String"][]>; notLike?: InputMaybe<Scalars["String"]> }

Type declaration

StripeCheckoutCredentialsFragment

StripeCheckoutCredentialsFragment: { __typename?: "StripeCheckoutCredentials"; accountId?: string | null; publicKey?: string | null; setupSecret: string }

Type declaration

  • Optional __typename?: "StripeCheckoutCredentials"
  • Optional accountId?: string | null
  • Optional publicKey?: string | null
  • setupSecret: string

StripeCredentialsInput

StripeCredentialsInput: { accountId?: InputMaybe<Scalars["String"]>; authorizationCode: Scalars["String"]; isTaxEnabled?: InputMaybe<Scalars["Boolean"]>; isTestMode: Scalars["Boolean"] }

Input configuration for Stripe integration

Type declaration

  • Optional accountId?: InputMaybe<Scalars["String"]>

    ID of the Stripe account

  • authorizationCode: Scalars["String"]

    Authorization code for Stripe

  • Optional isTaxEnabled?: InputMaybe<Scalars["Boolean"]>

    Whether tax is enabled for the Stripe account

  • isTestMode: Scalars["Boolean"]

    Whether the Stripe account is in test mode

StripeCustomerSearchInput

StripeCustomerSearchInput: { customerName?: InputMaybe<Scalars["String"]>; environmentId: Scalars["String"]; nextPage?: InputMaybe<Scalars["String"]> }

Input parameters for searching Stripe customers

Type declaration

  • Optional customerName?: InputMaybe<Scalars["String"]>

    Name of the customer to search for

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • Optional nextPage?: InputMaybe<Scalars["String"]>

    Token for retrieving the next page of results

StripeProductSearchInput

StripeProductSearchInput: { environmentId: Scalars["String"]; nextPage?: InputMaybe<Scalars["String"]>; productName?: InputMaybe<Scalars["String"]> }

Input parameters for searching Stripe products

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • Optional nextPage?: InputMaybe<Scalars["String"]>

    Token for retrieving the next page of results

  • Optional productName?: InputMaybe<Scalars["String"]>

    Name of the product to search for

StripeSubscriptionSearchInput

StripeSubscriptionSearchInput: { environmentId: Scalars["String"]; nextPage?: InputMaybe<Scalars["String"]> }

Input parameters for searching Stripe subscriptions

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • Optional nextPage?: InputMaybe<Scalars["String"]>

    Token for retrieving the next page of results

SubscribedCustomersCountInput

SubscribedCustomersCountInput: { environmentId: Scalars["String"]; packageRefId: Scalars["String"]; versionNumber?: InputMaybe<Scalars["Int"]> }

Get Subscribed Customers Count Input

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • packageRefId: Scalars["String"]

    The ref id of the package

  • Optional versionNumber?: InputMaybe<Scalars["Int"]>

    The version number of the package (optional - if not provided, counts all versions)

Subscription

Subscription: { addons: SubscriptionAddon[]; billingId?: string; cancellationDate?: Date; crmId?: string; currentBillingPeriodEnd?: Date; effectiveEndDate?: Date; endDate?: Date; experimentInfo?: ExperimentInfo | null; futureUpdates: SubscriptionFutureUpdateDataFragment[]; id: string; latestInvoice?: SubscriptionInvoiceFragment; metadata?: Metadata | null; payingCustomer?: SlimCustomer | null; paymentCollection: PaymentCollection; paymentCollectionMethod?: PaymentCollectionMethod; plan: Plan; price: SubscriptionPrice | null; prices: Price[]; pricingType: PricingType; resourceId?: string; scheduledUpdates?: CustomerPortalSubscriptionScheduledUpdateDataFragment[]; startDate: Date; status: SubscriptionStatus; totalPrice: TotalPriceFragment | null | undefined; trialEndDate?: Date }

Type declaration

SubscriptionAddon

SubscriptionAddon: { addon: Addon; quantity: number }

Type declaration

  • addon: Addon
  • quantity: number

SubscriptionAddonFilter

SubscriptionAddonFilter: { and?: InputMaybe<SubscriptionAddonFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<SubscriptionAddonFilter[]>; price?: InputMaybe<SubscriptionAddonFilterPriceFilter>; quantity?: InputMaybe<NumberFieldComparison>; subscription?: InputMaybe<SubscriptionAddonFilterCustomerSubscriptionFilter>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

SubscriptionAddonFilterCustomerSubscriptionFilter

SubscriptionAddonFilterCustomerSubscriptionFilter: { and?: InputMaybe<SubscriptionAddonFilterCustomerSubscriptionFilter[]>; billingCycleAnchor?: InputMaybe<DateFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; cancelReason?: InputMaybe<SubscriptionCancelReasonFilterComparison>; cancellationDate?: InputMaybe<DateFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; crmLinkUrl?: InputMaybe<StringFieldComparison>; currentBillingPeriodEnd?: InputMaybe<DateFieldComparison>; currentBillingPeriodStart?: InputMaybe<DateFieldComparison>; customerId?: InputMaybe<UuidFilterComparison>; effectiveEndDate?: InputMaybe<DateFieldComparison>; endDate?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; oldBillingId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<SubscriptionAddonFilterCustomerSubscriptionFilter[]>; payingCustomerId?: InputMaybe<UuidFilterComparison>; paymentCollection?: InputMaybe<PaymentCollectionFilterComparison>; pricingType?: InputMaybe<PricingTypeFilterComparison>; refId?: InputMaybe<StringFieldComparison>; resourceId?: InputMaybe<UuidFilterComparison>; salesforceId?: InputMaybe<StringFieldComparison>; startDate?: InputMaybe<DateFieldComparison>; status?: InputMaybe<SubscriptionStatusFilterComparison>; subscriptionId?: InputMaybe<StringFieldComparison>; trialEndDate?: InputMaybe<DateFieldComparison> }

Type declaration

SubscriptionAddonFilterPriceFilter

SubscriptionAddonFilterPriceFilter: { and?: InputMaybe<SubscriptionAddonFilterPriceFilter[]>; billingCadence?: InputMaybe<BillingCadenceFilterComparison>; billingId?: InputMaybe<StringFieldComparison>; billingModel?: InputMaybe<BillingModelFilterComparison>; billingPeriod?: InputMaybe<BillingPeriodFilterComparison>; createdAt?: InputMaybe<DateFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<SubscriptionAddonFilterPriceFilter[]>; tiersMode?: InputMaybe<TiersModeFilterComparison> }

Type declaration

SubscriptionAddonInput

SubscriptionAddonInput: { addonId: Scalars["String"]; quantity?: InputMaybe<Scalars["Int"]> }

Type declaration

SubscriptionAddonSort

SubscriptionAddonSort: { direction: SortDirection; field: SubscriptionAddonSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

SubscriptionBillingInfo

SubscriptionBillingInfo: { billingAddress?: BillingAddress; integrationId?: string; prorationBehavior?: SubscriptionProrationBehavior; taxIds?: TaxId[]; taxPercentage?: number; taxRateIds?: string[] }

Type declaration

SubscriptionCancelReasonFilterComparison

SubscriptionCancelReasonFilterComparison: { eq?: InputMaybe<SubscriptionCancelReason>; gt?: InputMaybe<SubscriptionCancelReason>; gte?: InputMaybe<SubscriptionCancelReason>; iLike?: InputMaybe<SubscriptionCancelReason>; in?: InputMaybe<SubscriptionCancelReason[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<SubscriptionCancelReason>; lt?: InputMaybe<SubscriptionCancelReason>; lte?: InputMaybe<SubscriptionCancelReason>; neq?: InputMaybe<SubscriptionCancelReason>; notILike?: InputMaybe<SubscriptionCancelReason>; notIn?: InputMaybe<SubscriptionCancelReason[]>; notLike?: InputMaybe<SubscriptionCancelReason> }

Type declaration

SubscriptionCancellationInput

SubscriptionCancellationInput: { awaitSubscriptionCancellation?: InputMaybe<Scalars["Boolean"]>; endDate?: InputMaybe<Scalars["DateTime"]>; environmentId?: InputMaybe<Scalars["UUID"]>; prorate?: InputMaybe<Scalars["Boolean"]>; subscriptionCancellationAction?: InputMaybe<SubscriptionCancellationAction>; subscriptionCancellationTime?: InputMaybe<SubscriptionCancellationTime>; subscriptionRefId: Scalars["String"] }

Type declaration

SubscriptionCouponConfigurationInput

SubscriptionCouponConfigurationInput: { startDate?: InputMaybe<Scalars["DateTime"]> }

Subscription coupon configuration input

Type declaration

  • Optional startDate?: InputMaybe<Scalars["DateTime"]>

    The date to start the coupon from

SubscriptionCouponDiscountInput

SubscriptionCouponDiscountInput: { amountsOff?: InputMaybe<MoneyInputDto[]>; description?: InputMaybe<Scalars["String"]>; durationInMonths?: InputMaybe<Scalars["Float"]>; name?: InputMaybe<Scalars["String"]>; percentOff?: InputMaybe<Scalars["Float"]> }

Inline subscription coupon input

Type declaration

  • Optional amountsOff?: InputMaybe<MoneyInputDto[]>

    Discount flat fee amounts off

  • Optional description?: InputMaybe<Scalars["String"]>

    Description of the coupon that will be created

  • Optional durationInMonths?: InputMaybe<Scalars["Float"]>

    The duration in months for which the coupon remains active.

  • Optional name?: InputMaybe<Scalars["String"]>

    Name of the coupon that will be created

  • Optional percentOff?: InputMaybe<Scalars["Float"]>

    Discount percent off

SubscriptionCouponInput

SubscriptionCouponInput: { billingCouponId?: InputMaybe<Scalars["String"]>; configuration?: InputMaybe<SubscriptionCouponConfigurationInput>; couponId?: InputMaybe<Scalars["String"]>; discount?: InputMaybe<SubscriptionCouponDiscountInput>; promotionCode?: InputMaybe<Scalars["String"]> }

Subscription coupon input

Type declaration

SubscriptionEntitlementFilter

SubscriptionEntitlementFilter: { and?: InputMaybe<SubscriptionEntitlementFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; feature?: InputMaybe<SubscriptionEntitlementFilterFeatureFilter>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<SubscriptionEntitlementFilter[]>; subscription?: InputMaybe<SubscriptionEntitlementFilterCustomerSubscriptionFilter>; subscriptionId?: InputMaybe<StringFieldComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

SubscriptionEntitlementFilterCustomerSubscriptionFilter

SubscriptionEntitlementFilterCustomerSubscriptionFilter: { and?: InputMaybe<SubscriptionEntitlementFilterCustomerSubscriptionFilter[]>; billingCycleAnchor?: InputMaybe<DateFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; cancelReason?: InputMaybe<SubscriptionCancelReasonFilterComparison>; cancellationDate?: InputMaybe<DateFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; crmLinkUrl?: InputMaybe<StringFieldComparison>; currentBillingPeriodEnd?: InputMaybe<DateFieldComparison>; currentBillingPeriodStart?: InputMaybe<DateFieldComparison>; customerId?: InputMaybe<UuidFilterComparison>; effectiveEndDate?: InputMaybe<DateFieldComparison>; endDate?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; oldBillingId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<SubscriptionEntitlementFilterCustomerSubscriptionFilter[]>; payingCustomerId?: InputMaybe<UuidFilterComparison>; paymentCollection?: InputMaybe<PaymentCollectionFilterComparison>; pricingType?: InputMaybe<PricingTypeFilterComparison>; refId?: InputMaybe<StringFieldComparison>; resourceId?: InputMaybe<UuidFilterComparison>; salesforceId?: InputMaybe<StringFieldComparison>; startDate?: InputMaybe<DateFieldComparison>; status?: InputMaybe<SubscriptionStatusFilterComparison>; subscriptionId?: InputMaybe<StringFieldComparison>; trialEndDate?: InputMaybe<DateFieldComparison> }

Type declaration

SubscriptionEntitlementFilterFeatureFilter

SubscriptionEntitlementFilterFeatureFilter: { and?: InputMaybe<SubscriptionEntitlementFilterFeatureFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; featureStatus?: InputMaybe<FeatureStatusFilterComparison>; featureType?: InputMaybe<FeatureTypeFilterComparison>; id?: InputMaybe<UuidFilterComparison>; meterType?: InputMaybe<MeterTypeFilterComparison>; or?: InputMaybe<SubscriptionEntitlementFilterFeatureFilter[]>; refId?: InputMaybe<StringFieldComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

SubscriptionEntitlementInput

SubscriptionEntitlementInput: { description?: InputMaybe<Scalars["String"]>; featureId: Scalars["String"]; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Subscription entitlement input

Type declaration

SubscriptionEntitlementSort

SubscriptionEntitlementSort: { direction: SortDirection; field: SubscriptionEntitlementSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

SubscriptionEstimationAddon

SubscriptionEstimationAddon: { addonId: string; quantity?: number }

Type declaration

  • addonId: string
  • Optional quantity?: number

SubscriptionFragment

SubscriptionFragment: { __typename?: "CustomerSubscription"; additionalMetaData?: any | null; addons?: { __typename?: "SubscriptionAddon"; addon: { __typename?: "Addon" } & AddonFragment; id: any; quantity: number }[] | null; billingId?: string | null; billingLinkUrl?: string | null; billingSyncError?: string | null; cancellationDate?: any | null; currentBillingPeriodEnd?: any | null; effectiveEndDate?: any | null; endDate?: any | null; experimentInfo?: { __typename?: "experimentInfo"; groupName: string; groupType: ExperimentGroupType; id: string; name: string } | null; futureUpdates: ({ __typename?: "SubscriptionFutureUpdate" } & SubscriptionFutureUpdateDataFragment)[]; id: any; latestInvoice?: ({ __typename?: "SubscriptionInvoice" } & SubscriptionInvoiceFragment) | null; payingCustomer?: ({ __typename?: "Customer" } & SlimCustomerFragment) | null; paymentCollection: PaymentCollection; paymentCollectionMethod?: PaymentCollectionMethod | null; plan: { __typename?: "Plan" } & PlanFragment; prices?: { __typename?: "SubscriptionPrice"; price?: ({ __typename?: "Price" } & PriceFragment) | null; usageLimit?: number | null }[] | null; pricingType: PricingType; refId: string; resource?: ({ __typename?: "CustomerResource" } & CustomerResourceFragment) | null; scheduledUpdates?: ({ __typename?: "SubscriptionScheduledUpdate" } & SubscriptionScheduledUpdateDataFragment)[] | null; startDate: any; status: SubscriptionStatus; subscriptionId: string; totalPrice?: ({ __typename?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment) | null; trialConfiguration?: ({ __typename?: "TrialConfiguration" } & SubscriptionTrialConfigurationFragment) | null; trialEndDate?: any | null }

Type declaration

  • Optional __typename?: "CustomerSubscription"
  • Optional additionalMetaData?: any | null
  • Optional addons?: { __typename?: "SubscriptionAddon"; addon: { __typename?: "Addon" } & AddonFragment; id: any; quantity: number }[] | null
  • Optional billingId?: string | null
  • Optional billingLinkUrl?: string | null
  • Optional billingSyncError?: string | null
  • Optional cancellationDate?: any | null
  • Optional currentBillingPeriodEnd?: any | null
  • Optional effectiveEndDate?: any | null
  • Optional endDate?: any | null
  • Optional experimentInfo?: { __typename?: "experimentInfo"; groupName: string; groupType: ExperimentGroupType; id: string; name: string } | null
  • futureUpdates: ({ __typename?: "SubscriptionFutureUpdate" } & SubscriptionFutureUpdateDataFragment)[]
  • id: any
  • Optional latestInvoice?: ({ __typename?: "SubscriptionInvoice" } & SubscriptionInvoiceFragment) | null
  • Optional payingCustomer?: ({ __typename?: "Customer" } & SlimCustomerFragment) | null
  • paymentCollection: PaymentCollection
  • Optional paymentCollectionMethod?: PaymentCollectionMethod | null
  • plan: { __typename?: "Plan" } & PlanFragment
  • Optional prices?: { __typename?: "SubscriptionPrice"; price?: ({ __typename?: "Price" } & PriceFragment) | null; usageLimit?: number | null }[] | null
  • pricingType: PricingType
  • refId: string
  • Optional resource?: ({ __typename?: "CustomerResource" } & CustomerResourceFragment) | null
  • Optional scheduledUpdates?: ({ __typename?: "SubscriptionScheduledUpdate" } & SubscriptionScheduledUpdateDataFragment)[] | null
  • startDate: any
  • status: SubscriptionStatus
  • subscriptionId: string
  • Optional totalPrice?: ({ __typename?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment) | null
  • Optional trialConfiguration?: ({ __typename?: "TrialConfiguration" } & SubscriptionTrialConfigurationFragment) | null
  • Optional trialEndDate?: any | null

SubscriptionFutureUpdateDataFragment

SubscriptionFutureUpdateDataFragment: { __typename?: "SubscriptionFutureUpdate"; scheduleStatus: SubscriptionScheduleStatus; scheduleVariables?: ({ __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_) | ({ __typename?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_) | ({ __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_) | ({ __typename?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_) | ({ __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_) | ({ __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_) | ({ __typename?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_) | ({ __typename?: "RecurringCreditsChangeVariables" } & ScheduleVariablesFragment_RecurringCreditsChangeVariables_) | ({ __typename?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_) | null; scheduledExecutionTime: any; subscriptionScheduleType: SubscriptionScheduleType; targetPackage?: { __typename?: "PackageDTO"; displayName: string; id: any; refId: string } | null }

Type declaration

  • Optional __typename?: "SubscriptionFutureUpdate"
  • scheduleStatus: SubscriptionScheduleStatus
  • Optional scheduleVariables?: ({ __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_) | ({ __typename?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_) | ({ __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_) | ({ __typename?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_) | ({ __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_) | ({ __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_) | ({ __typename?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_) | ({ __typename?: "RecurringCreditsChangeVariables" } & ScheduleVariablesFragment_RecurringCreditsChangeVariables_) | ({ __typename?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_) | null
  • scheduledExecutionTime: any
  • subscriptionScheduleType: SubscriptionScheduleType
  • Optional targetPackage?: { __typename?: "PackageDTO"; displayName: string; id: any; refId: string } | null

SubscriptionInput

SubscriptionInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; addons?: InputMaybe<SubscriptionAddonInput[]>; appliedCoupon?: InputMaybe<SubscriptionCouponInput>; awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; billingCountryCode?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<SubscriptionBillingInfo>; billingPeriod?: InputMaybe<BillingPeriod>; budget?: InputMaybe<BudgetConfigurationInput>; charges?: InputMaybe<ChargeInput[]>; crmId?: InputMaybe<Scalars["String"]>; customerId: Scalars["String"]; endDate?: InputMaybe<Scalars["DateTime"]>; environmentId?: InputMaybe<Scalars["UUID"]>; isCustomPriceSubscription?: InputMaybe<Scalars["Boolean"]>; isOverridingTrialConfig?: InputMaybe<Scalars["Boolean"]>; isTrial?: InputMaybe<Scalars["Boolean"]>; minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>; payingCustomerId?: InputMaybe<Scalars["String"]>; paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>; planId: Scalars["String"]; priceOverrides?: InputMaybe<PriceOverrideInput[]>; priceUnitAmount?: InputMaybe<Scalars["Float"]>; promotionCode?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]>; resourceId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; scheduleStrategy?: InputMaybe<ScheduleStrategy>; startDate?: InputMaybe<Scalars["DateTime"]>; subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>; subscriptionId?: InputMaybe<Scalars["String"]>; trialEndBehavior?: InputMaybe<TrialEndBehavior>; unitQuantity?: InputMaybe<Scalars["Float"]> }

Type declaration

SubscriptionInvoiceFragment

SubscriptionInvoiceFragment: { __typename?: "SubscriptionInvoice"; amountDue?: number | null; attemptCount?: number | null; billingId: string; billingReason?: SubscriptionInvoiceBillingReason | null; createdAt: any; currency?: string | null; dueDate?: any | null; errorMessage?: string | null; paymentSecret?: string | null; paymentUrl?: string | null; pdfUrl?: string | null; requiresAction: boolean; status: SubscriptionInvoiceStatus; subTotal?: number | null; subTotalExcludingTax?: number | null; tax?: number | null; total?: number | null; totalExcludingTax?: number | null; updatedAt: any }

Type declaration

  • Optional __typename?: "SubscriptionInvoice"
  • Optional amountDue?: number | null
  • Optional attemptCount?: number | null
  • billingId: string
  • Optional billingReason?: SubscriptionInvoiceBillingReason | null
  • createdAt: any
  • Optional currency?: string | null
  • Optional dueDate?: any | null
  • Optional errorMessage?: string | null
  • Optional paymentSecret?: string | null
  • Optional paymentUrl?: string | null
  • Optional pdfUrl?: string | null
  • requiresAction: boolean
  • status: SubscriptionInvoiceStatus
  • Optional subTotal?: number | null
  • Optional subTotalExcludingTax?: number | null
  • Optional tax?: number | null
  • Optional total?: number | null
  • Optional totalExcludingTax?: number | null
  • updatedAt: any

SubscriptionInvoicePreviewFragment

SubscriptionInvoicePreviewFragment: { __typename?: "SubscriptionInvoicePreview"; amountDue: { __typename?: "Money"; amount: number; currency: Currency }; credits?: { __typename?: "SubscriptionPreviewCredits"; initial: { __typename?: "Money"; amount: number; currency: Currency }; remaining: { __typename?: "Money"; amount: number; currency: Currency }; used: { __typename?: "Money"; amount: number; currency: Currency } } | null; discount?: { __typename?: "Money"; amount: number; currency: Currency } | null; discountDetails?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; name?: string | null; type: DiscountType; value: number } | null; lastUpdatedAt: any; lines: { __typename?: "SubscriptionInvoicePreviewLineItem"; amount: { __typename?: "Money"; amount: number; currency: Currency }; costDescription: string; description: string; hasSoftLimit?: boolean | null; lines?: { __typename?: "SubscriptionInvoicePreviewLineItemData"; costDescription: string; description: string; hasSoftLimit?: boolean | null; proration: boolean; quantity?: number | null; type: InvoiceLineItemType; usageLimit?: number | null }[] | null; period: { __typename?: "SubscriptionInvoicePreviewLineItemPeriod"; end: any; start: any }; price?: ({ __typename?: "Price" } & PriceFragment) | null; proration: boolean; quantity?: number | null; type: InvoiceLineItemType; unitPrice?: { __typename?: "Money"; amount: number; currency: Currency } | null; usageLimit?: number | null }[]; minimumSpendAdjustment: { __typename?: "Money"; amount: number; currency: Currency }; subTotal: { __typename?: "Money"; amount: number; currency: Currency }; subTotalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency }; tax?: { __typename?: "Money"; amount: number; currency: Currency } | null; taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null; total: { __typename?: "Money"; amount: number; currency: Currency }; totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency } }

Type declaration

  • Optional __typename?: "SubscriptionInvoicePreview"
  • amountDue: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • Optional credits?: { __typename?: "SubscriptionPreviewCredits"; initial: { __typename?: "Money"; amount: number; currency: Currency }; remaining: { __typename?: "Money"; amount: number; currency: Currency }; used: { __typename?: "Money"; amount: number; currency: Currency } } | null
  • Optional discount?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional discountDetails?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; name?: string | null; type: DiscountType; value: number } | null
  • lastUpdatedAt: any
  • lines: { __typename?: "SubscriptionInvoicePreviewLineItem"; amount: { __typename?: "Money"; amount: number; currency: Currency }; costDescription: string; description: string; hasSoftLimit?: boolean | null; lines?: { __typename?: "SubscriptionInvoicePreviewLineItemData"; costDescription: string; description: string; hasSoftLimit?: boolean | null; proration: boolean; quantity?: number | null; type: InvoiceLineItemType; usageLimit?: number | null }[] | null; period: { __typename?: "SubscriptionInvoicePreviewLineItemPeriod"; end: any; start: any }; price?: ({ __typename?: "Price" } & PriceFragment) | null; proration: boolean; quantity?: number | null; type: InvoiceLineItemType; unitPrice?: { __typename?: "Money"; amount: number; currency: Currency } | null; usageLimit?: number | null }[]
  • minimumSpendAdjustment: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • subTotal: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • subTotalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • Optional tax?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null
  • total: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency

SubscriptionMigrationInput

SubscriptionMigrationInput: { environmentId?: InputMaybe<Scalars["UUID"]>; subscriptionId: Scalars["String"]; subscriptionMigrationTime?: InputMaybe<SubscriptionMigrationTime> }

Type declaration

SubscriptionMigrationTaskFilter

SubscriptionMigrationTaskFilter: { and?: InputMaybe<SubscriptionMigrationTaskFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<StringFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<SubscriptionMigrationTaskFilter[]>; status?: InputMaybe<TaskStatusFilterComparison>; taskType?: InputMaybe<TaskTypeFilterComparison> }

Type declaration

SubscriptionMigrationTaskSort

SubscriptionMigrationTaskSort: { direction: SortDirection; field: SubscriptionMigrationTaskSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

SubscriptionMinimumSpendValueInput

SubscriptionMinimumSpendValueInput: { minimum?: InputMaybe<MoneyInputDto> }

Subscription minimum spend input

Type declaration

SubscriptionPreviewCredits

SubscriptionPreviewCredits: { initial: Money; remaining: Money; used: Money }

Type declaration

SubscriptionPreviewDiscount

SubscriptionPreviewDiscount: { durationInMonths?: number; durationType: DiscountDurationType; name?: string | null; type: DiscountType; value: number }

Type declaration

SubscriptionPreviewFragment

SubscriptionPreviewFragment: { __typename?: "SubscriptionPreview"; billingPeriodRange: { __typename?: "DateRange"; end?: any | null; start?: any | null }; credits?: { __typename?: "SubscriptionPreviewCredits"; initial: { __typename?: "Money"; amount: number; currency: Currency }; remaining: { __typename?: "Money"; amount: number; currency: Currency }; used: { __typename?: "Money"; amount: number; currency: Currency } } | null; discount?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; name?: string | null; type: DiscountType; value: number } | null; discountAmount?: { __typename?: "Money"; amount: number; currency: Currency } | null; hasScheduledUpdates?: boolean | null; isPlanDowngrade?: boolean | null; proration?: { __typename?: "SubscriptionPreviewProrations"; credit: { __typename?: "Money"; amount: number; currency: Currency }; debit: { __typename?: "Money"; amount: number; currency: Currency }; netAmount: { __typename?: "Money"; amount: number; currency: Currency }; prorationDate: any } | null; subTotal: { __typename?: "Money"; amount: number; currency: Currency }; subscription?: { __typename?: "SubscriptionPricePreviewDTO"; discount?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; name?: string | null; type: DiscountType; value: number } | null; discountAmount?: { __typename?: "Money"; amount: number; currency: Currency } | null; subTotal: { __typename?: "Money"; amount: number; currency: Currency }; tax: { __typename?: "Money"; amount: number; currency: Currency }; taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null; total: { __typename?: "Money"; amount: number; currency: Currency }; totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency } } | null; tax?: { __typename?: "Money"; amount: number; currency: Currency } | null; taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null; total: { __typename?: "Money"; amount: number; currency: Currency }; totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency } }

Type declaration

  • Optional __typename?: "SubscriptionPreview"
  • billingPeriodRange: { __typename?: "DateRange"; end?: any | null; start?: any | null }
    • Optional __typename?: "DateRange"
    • Optional end?: any | null
    • Optional start?: any | null
  • Optional credits?: { __typename?: "SubscriptionPreviewCredits"; initial: { __typename?: "Money"; amount: number; currency: Currency }; remaining: { __typename?: "Money"; amount: number; currency: Currency }; used: { __typename?: "Money"; amount: number; currency: Currency } } | null
  • Optional discount?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; name?: string | null; type: DiscountType; value: number } | null
  • Optional discountAmount?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional hasScheduledUpdates?: boolean | null
  • Optional isPlanDowngrade?: boolean | null
  • Optional proration?: { __typename?: "SubscriptionPreviewProrations"; credit: { __typename?: "Money"; amount: number; currency: Currency }; debit: { __typename?: "Money"; amount: number; currency: Currency }; netAmount: { __typename?: "Money"; amount: number; currency: Currency }; prorationDate: any } | null
  • subTotal: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • Optional subscription?: { __typename?: "SubscriptionPricePreviewDTO"; discount?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; name?: string | null; type: DiscountType; value: number } | null; discountAmount?: { __typename?: "Money"; amount: number; currency: Currency } | null; subTotal: { __typename?: "Money"; amount: number; currency: Currency }; tax: { __typename?: "Money"; amount: number; currency: Currency }; taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null; total: { __typename?: "Money"; amount: number; currency: Currency }; totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency } } | null
  • Optional tax?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null
  • total: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency

SubscriptionPreviewInvoice

SubscriptionPreviewInvoice: { discount?: Money; discountDetails?: SubscriptionPreviewDiscount; subTotal: Money; tax?: Money; taxDetails?: SubscriptionPreviewTaxDetails; total: Money; totalExcludingTax: Money }

Type declaration

SubscriptionPreviewInvoiceFragment

SubscriptionPreviewInvoiceFragment: { __typename?: "SubscriptionPreviewInvoice"; discount?: { __typename?: "Money"; amount: number; currency: Currency } | null; discountDetails?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; type: DiscountType; value: number } | null; subTotal: { __typename?: "Money"; amount: number; currency: Currency }; tax?: { __typename?: "Money"; amount: number; currency: Currency } | null; taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null; total: { __typename?: "Money"; amount: number; currency: Currency }; totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency } }

Type declaration

  • Optional __typename?: "SubscriptionPreviewInvoice"
  • Optional discount?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional discountDetails?: { __typename?: "SubscriptionPreviewDiscount"; durationInMonths?: number | null; durationType: DiscountDurationType; type: DiscountType; value: number } | null
  • subTotal: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • Optional tax?: { __typename?: "Money"; amount: number; currency: Currency } | null
  • Optional taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails"; displayName: string; inclusive: boolean; percentage: number } | null
  • total: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • totalExcludingTax: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency

SubscriptionPreviewProration

SubscriptionPreviewProration: { credit: Money; debit: Money; hasProrations?: boolean; netAmount: Money; prorationDate: Date }

Type declaration

  • credit: Money
  • debit: Money
  • Optional hasProrations?: boolean
  • netAmount: Money
  • prorationDate: Date

SubscriptionPreviewTaxDetails

SubscriptionPreviewTaxDetails: { displayName: string; inclusive: boolean; percentage: number }

Type declaration

  • displayName: string
  • inclusive: boolean
  • percentage: number

SubscriptionPreviewV2Fragment

SubscriptionPreviewV2Fragment: { __typename?: "SubscriptionPreviewV2"; billingPeriodRange: { __typename?: "DateRange"; end?: any | null; start?: any | null }; hasScheduledUpdates?: boolean | null; immediateInvoice: { __typename?: "ImmediateSubscriptionPreviewInvoice" } & ImmediateSubscriptionPreviewInvoiceFragment; isPlanDowngrade?: boolean | null; recurringInvoice?: ({ __typename?: "SubscriptionPreviewInvoice" } & SubscriptionPreviewInvoiceFragment) | null }

Type declaration

  • Optional __typename?: "SubscriptionPreviewV2"
  • billingPeriodRange: { __typename?: "DateRange"; end?: any | null; start?: any | null }
    • Optional __typename?: "DateRange"
    • Optional end?: any | null
    • Optional start?: any | null
  • Optional hasScheduledUpdates?: boolean | null
  • immediateInvoice: { __typename?: "ImmediateSubscriptionPreviewInvoice" } & ImmediateSubscriptionPreviewInvoiceFragment
  • Optional isPlanDowngrade?: boolean | null
  • Optional recurringInvoice?: ({ __typename?: "SubscriptionPreviewInvoice" } & SubscriptionPreviewInvoiceFragment) | null

SubscriptionPrice

SubscriptionPrice: Price & { grossAmount: number }

SubscriptionPriceFilter

SubscriptionPriceFilter: { and?: InputMaybe<SubscriptionPriceFilter[]>; billingModel?: InputMaybe<BillingModelFilterComparison>; createdAt?: InputMaybe<DateFieldComparison>; featureId?: InputMaybe<StringFieldComparison>; hasSoftLimit?: InputMaybe<BooleanFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<SubscriptionPriceFilter[]>; price?: InputMaybe<SubscriptionPriceFilterPriceFilter>; subscription?: InputMaybe<SubscriptionPriceFilterCustomerSubscriptionFilter>; updatedAt?: InputMaybe<DateFieldComparison>; usageLimit?: InputMaybe<NumberFieldComparison> }

Type declaration

SubscriptionPriceFilterCustomerSubscriptionFilter

SubscriptionPriceFilterCustomerSubscriptionFilter: { and?: InputMaybe<SubscriptionPriceFilterCustomerSubscriptionFilter[]>; billingCycleAnchor?: InputMaybe<DateFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; cancelReason?: InputMaybe<SubscriptionCancelReasonFilterComparison>; cancellationDate?: InputMaybe<DateFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; crmLinkUrl?: InputMaybe<StringFieldComparison>; currentBillingPeriodEnd?: InputMaybe<DateFieldComparison>; currentBillingPeriodStart?: InputMaybe<DateFieldComparison>; customerId?: InputMaybe<UuidFilterComparison>; effectiveEndDate?: InputMaybe<DateFieldComparison>; endDate?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; oldBillingId?: InputMaybe<StringFieldComparison>; or?: InputMaybe<SubscriptionPriceFilterCustomerSubscriptionFilter[]>; payingCustomerId?: InputMaybe<UuidFilterComparison>; paymentCollection?: InputMaybe<PaymentCollectionFilterComparison>; pricingType?: InputMaybe<PricingTypeFilterComparison>; refId?: InputMaybe<StringFieldComparison>; resourceId?: InputMaybe<UuidFilterComparison>; salesforceId?: InputMaybe<StringFieldComparison>; startDate?: InputMaybe<DateFieldComparison>; status?: InputMaybe<SubscriptionStatusFilterComparison>; subscriptionId?: InputMaybe<StringFieldComparison>; trialEndDate?: InputMaybe<DateFieldComparison> }

Type declaration

SubscriptionPriceFilterPriceFilter

SubscriptionPriceFilterPriceFilter: { and?: InputMaybe<SubscriptionPriceFilterPriceFilter[]>; billingCadence?: InputMaybe<BillingCadenceFilterComparison>; billingId?: InputMaybe<StringFieldComparison>; billingModel?: InputMaybe<BillingModelFilterComparison>; billingPeriod?: InputMaybe<BillingPeriodFilterComparison>; createdAt?: InputMaybe<DateFieldComparison>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<SubscriptionPriceFilterPriceFilter[]>; tiersMode?: InputMaybe<TiersModeFilterComparison> }

Type declaration

SubscriptionPricePreview

SubscriptionPricePreview: { discount?: SubscriptionPreviewDiscount; discountAmount?: Money; subTotal: Money; tax?: Money; taxDetails?: SubscriptionPreviewTaxDetails; total: Money; totalExcludingTax: Money }

Type declaration

SubscriptionPriceSort

SubscriptionPriceSort: { direction: SortDirection; field: SubscriptionPriceSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

SubscriptionQueryFilter

SubscriptionQueryFilter: { and?: InputMaybe<SubscriptionQueryFilter[]>; billingId?: InputMaybe<StringFieldComparison>; cancellationDate?: InputMaybe<DateFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; customer?: InputMaybe<SubscriptionQueryFilterCustomerFilter>; customerId?: InputMaybe<StringFieldComparison>; endDate?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<SubscriptionQueryFilter[]>; paymentCollection?: InputMaybe<PaymentCollectionFilterComparison>; plan?: InputMaybe<SubscriptionQueryFilterPlanFilter>; pricingType?: InputMaybe<PricingTypeFilterComparison>; productId?: InputMaybe<StringFieldComparison>; resource?: InputMaybe<SubscriptionQueryFilterCustomerResourceFilter>; resourceId?: InputMaybe<StringFieldComparison>; salesforceId?: InputMaybe<StringFieldComparison>; startDate?: InputMaybe<DateFieldComparison>; status?: InputMaybe<SubscriptionStatusFilterComparison>; subscriptionId?: InputMaybe<StringFieldComparison> }

Type declaration

SubscriptionQueryFilterCustomerFilter

SubscriptionQueryFilterCustomerFilter: { and?: InputMaybe<SubscriptionQueryFilterCustomerFilter[]>; awsMarketplaceCustomerId?: InputMaybe<StringFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmHubspotCompanyId?: InputMaybe<StringFieldComparison>; crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; customerId?: InputMaybe<StringFieldComparison>; deletedAt?: InputMaybe<DateFieldComparison>; email?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<SubscriptionQueryFilterCustomerFilter[]>; refId?: InputMaybe<StringFieldComparison>; salesforceId?: InputMaybe<StringFieldComparison>; searchQuery?: InputMaybe<CustomerSearchQueryFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

SubscriptionQueryFilterCustomerResourceFilter

SubscriptionQueryFilterCustomerResourceFilter: { and?: InputMaybe<SubscriptionQueryFilterCustomerResourceFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<SubscriptionQueryFilterCustomerResourceFilter[]>; resourceId?: InputMaybe<StringFieldComparison> }

Type declaration

SubscriptionQueryFilterPlanFilter

SubscriptionQueryFilterPlanFilter: { and?: InputMaybe<SubscriptionQueryFilterPlanFilter[]>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; isLatest?: InputMaybe<BooleanFieldComparison>; or?: InputMaybe<SubscriptionQueryFilterPlanFilter[]>; pricingType?: InputMaybe<PricingTypeFilterComparison>; productId?: InputMaybe<StringFieldComparison>; refId?: InputMaybe<StringFieldComparison>; status?: InputMaybe<PackageStatusFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison>; versionNumber?: InputMaybe<IntFieldComparison> }

Type declaration

SubscriptionQueryFragment

SubscriptionQueryFragment: { __typename?: "SubscriptionQuery"; addons?: { __typename?: "SubscriptionAddon"; addon: { __typename?: "Addon"; addonId: string }; quantity: number }[] | null; currentBillingPeriodEnd?: any | null; customer: { __typename?: "Customer"; customerId: string }; payingCustomer?: { __typename?: "Customer"; customerId: string } | null; plan: { __typename?: "Plan"; displayName: string; planId: string }; pricingType: PricingType; resource?: { __typename?: "CustomerResource"; resourceId: string } | null; startDate: any; status: SubscriptionStatus; subscriptionId: string; trialConfiguration?: { __typename?: "TrialConfiguration"; trialEndBehavior: TrialEndBehavior } | null; trialEndDate?: any | null }

Type declaration

  • Optional __typename?: "SubscriptionQuery"
  • Optional addons?: { __typename?: "SubscriptionAddon"; addon: { __typename?: "Addon"; addonId: string }; quantity: number }[] | null
  • Optional currentBillingPeriodEnd?: any | null
  • customer: { __typename?: "Customer"; customerId: string }
    • Optional __typename?: "Customer"
    • customerId: string
  • Optional payingCustomer?: { __typename?: "Customer"; customerId: string } | null
  • plan: { __typename?: "Plan"; displayName: string; planId: string }
    • Optional __typename?: "Plan"
    • displayName: string
    • planId: string
  • pricingType: PricingType
  • Optional resource?: { __typename?: "CustomerResource"; resourceId: string } | null
  • startDate: any
  • status: SubscriptionStatus
  • subscriptionId: string
  • Optional trialConfiguration?: { __typename?: "TrialConfiguration"; trialEndBehavior: TrialEndBehavior } | null
  • Optional trialEndDate?: any | null

SubscriptionQuerySort

SubscriptionQuerySort: { direction: SortDirection; field: SubscriptionQuerySortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

SubscriptionScheduledUpdateDataFragment

SubscriptionScheduledUpdateDataFragment: { __typename?: "SubscriptionScheduledUpdate"; scheduleStatus: SubscriptionScheduleStatus; scheduleVariables?: ({ __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_) | ({ __typename?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_) | ({ __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_) | ({ __typename?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_) | ({ __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_) | ({ __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_) | ({ __typename?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_) | ({ __typename?: "RecurringCreditsChangeVariables" } & ScheduleVariablesFragment_RecurringCreditsChangeVariables_) | ({ __typename?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_) | null; scheduledExecutionTime: any; subscriptionScheduleType: SubscriptionScheduleType; targetPackage?: { __typename?: "PackageDTO"; displayName: string; id: any; refId: string } | null }

Type declaration

  • Optional __typename?: "SubscriptionScheduledUpdate"
  • scheduleStatus: SubscriptionScheduleStatus
  • Optional scheduleVariables?: ({ __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_) | ({ __typename?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_) | ({ __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_) | ({ __typename?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_) | ({ __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_) | ({ __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_) | ({ __typename?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_) | ({ __typename?: "RecurringCreditsChangeVariables" } & ScheduleVariablesFragment_RecurringCreditsChangeVariables_) | ({ __typename?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_) | null
  • scheduledExecutionTime: any
  • subscriptionScheduleType: SubscriptionScheduleType
  • Optional targetPackage?: { __typename?: "PackageDTO"; displayName: string; id: any; refId: string } | null

SubscriptionStatusFilterComparison

SubscriptionStatusFilterComparison: { eq?: InputMaybe<SubscriptionStatus>; gt?: InputMaybe<SubscriptionStatus>; gte?: InputMaybe<SubscriptionStatus>; iLike?: InputMaybe<SubscriptionStatus>; in?: InputMaybe<SubscriptionStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<SubscriptionStatus>; lt?: InputMaybe<SubscriptionStatus>; lte?: InputMaybe<SubscriptionStatus>; neq?: InputMaybe<SubscriptionStatus>; notILike?: InputMaybe<SubscriptionStatus>; notIn?: InputMaybe<SubscriptionStatus[]>; notLike?: InputMaybe<SubscriptionStatus> }

Type declaration

SubscriptionTrialConfigurationFragment

SubscriptionTrialConfigurationFragment: { __typename?: "TrialConfiguration"; trialEndBehavior: TrialEndBehavior }

Type declaration

SubscriptionUpdateScheduleCancellationInput

SubscriptionUpdateScheduleCancellationInput: { environmentId?: InputMaybe<Scalars["UUID"]>; status?: InputMaybe<SubscriptionScheduleStatus>; subscriptionId: Scalars["String"] }

Type declaration

SubscriptionUpdateUsageResetCutoffRuleInput

SubscriptionUpdateUsageResetCutoffRuleInput: { behavior: SubscriptionUpdateUsageCutoffBehavior }

Input for usage reset cutoff rule

Type declaration

SyncTaxRatesInput

SyncTaxRatesInput: { environmentId?: InputMaybe<Scalars["UUID"]> }

Input for triggering a sync of tax rates from the billing provider.

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The ID of the environment for which tax rates should be synced.

TaskStatusFilterComparison

TaskStatusFilterComparison: { eq?: InputMaybe<TaskStatus>; gt?: InputMaybe<TaskStatus>; gte?: InputMaybe<TaskStatus>; iLike?: InputMaybe<TaskStatus>; in?: InputMaybe<TaskStatus[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<TaskStatus>; lt?: InputMaybe<TaskStatus>; lte?: InputMaybe<TaskStatus>; neq?: InputMaybe<TaskStatus>; notILike?: InputMaybe<TaskStatus>; notIn?: InputMaybe<TaskStatus[]>; notLike?: InputMaybe<TaskStatus> }

Type declaration

TaskTypeFilterComparison

TaskTypeFilterComparison: { eq?: InputMaybe<TaskType>; gt?: InputMaybe<TaskType>; gte?: InputMaybe<TaskType>; iLike?: InputMaybe<TaskType>; in?: InputMaybe<TaskType[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<TaskType>; lt?: InputMaybe<TaskType>; lte?: InputMaybe<TaskType>; neq?: InputMaybe<TaskType>; notILike?: InputMaybe<TaskType>; notIn?: InputMaybe<TaskType[]>; notLike?: InputMaybe<TaskType> }

Type declaration

TaxExempt

TaxExempt: { type: Scalars["String"]; value: Scalars["String"] }

Information on the tax exemption.

Type declaration

  • type: Scalars["String"]

    The type of tax exemption identifier, such as VAT.

  • value: Scalars["String"]

    The actual tax identifier value

TaxId

TaxId: { type: string; value: string }

Type declaration

  • type: string
  • value: string

TestHookInput

TestHookInput: { endpointUrl: Scalars["String"]; environmentId: Scalars["String"]; hookEventType: EventLogType }

TestHookInput object

Type declaration

  • endpointUrl: Scalars["String"]

    The endpoint URL for the webhook

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • hookEventType: EventLogType

    The event log type to test

TestWorkflowInput

TestWorkflowInput: { endpointUrl: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; hookEventType: EventLogType }

Trigger workflow with test event input

Type declaration

  • endpointUrl: Scalars["String"]

    Workflow trigger endpoint

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • hookEventType: EventLogType

    The event type to trigger the workflow on

TiersModeFilterComparison

TiersModeFilterComparison: { eq?: InputMaybe<TiersMode>; gt?: InputMaybe<TiersMode>; gte?: InputMaybe<TiersMode>; iLike?: InputMaybe<TiersMode>; in?: InputMaybe<TiersMode[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<TiersMode>; lt?: InputMaybe<TiersMode>; lte?: InputMaybe<TiersMode>; neq?: InputMaybe<TiersMode>; notILike?: InputMaybe<TiersMode>; notIn?: InputMaybe<TiersMode[]>; notLike?: InputMaybe<TiersMode> }

Type declaration

TotalPriceFragment

TotalPriceFragment: { __typename?: "CustomerSubscriptionTotalPrice"; subTotal: { __typename?: "Money"; amount: number; currency: Currency }; total: { __typename?: "Money"; amount: number; currency: Currency } }

Type declaration

  • Optional __typename?: "CustomerSubscriptionTotalPrice"
  • subTotal: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • total: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency

TransferSubscriptionInput

TransferSubscriptionInput: { customerId: Scalars["String"]; destinationResourceId: Scalars["String"]; sourceResourceId: Scalars["String"] }

Type declaration

TransferSubscriptionMutation

TransferSubscriptionMutation: { __typename?: "Mutation"; transferSubscription: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • transferSubscription: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment

TransferSubscriptionMutationVariables

TransferSubscriptionMutationVariables: Exact<{ input: TransferSubscriptionInput }>

TransferSubscriptionToResourceInput

TransferSubscriptionToResourceInput: { destinationResourceId?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; subscriptionId: Scalars["String"] }

The input for transferring a subscription to a resource

Type declaration

  • Optional destinationResourceId?: InputMaybe<Scalars["String"]>

    The resource ID to transfer the subscription to

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The environment ID of the subscription to transfer

  • subscriptionId: Scalars["String"]

    The ID of the subscription to transfer

TransferSubscriptionToResourceMutation

TransferSubscriptionToResourceMutation: { __typename?: "Mutation"; transferSubscriptionToResource: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • transferSubscriptionToResource: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment

TransferSubscriptionToResourceMutationVariables

TransferSubscriptionToResourceMutationVariables: Exact<{ input: TransferSubscriptionToResourceInput }>

TrialOverrideConfigurationInput

TrialOverrideConfigurationInput: { isTrial: Scalars["Boolean"]; trialEndBehavior?: InputMaybe<TrialEndBehavior>; trialEndDate?: InputMaybe<Scalars["DateTime"]> }

Type declaration

TrialedPlan

TrialedPlan: { planId?: string | null; productId?: string | null }

Type declaration

  • Optional planId?: string | null
  • Optional productId?: string | null

TriggerSubscriptionBillingMonthEndsSoonWebhookInput

TriggerSubscriptionBillingMonthEndsSoonWebhookInput: { subscriptionId: Scalars["String"] }

Input for triggering the subscription billing month ends soon webhook

Type declaration

  • subscriptionId: Scalars["String"]

    The subscription reference id to trigger the webhook for

TriggerSubscriptionMigrationInput

TriggerSubscriptionMigrationInput: { environmentId: Scalars["String"]; refId: Scalars["String"]; versionNumber: Scalars["Float"] }

Trigger a subscription migration

Type declaration

  • environmentId: Scalars["String"]

    The unique identifier for the environment

  • refId: Scalars["String"]

    The unique identifier for the entity

  • versionNumber: Scalars["Float"]

    The version number of the plan to migrate

TriggerSubscriptionUsageSyncInput

TriggerSubscriptionUsageSyncInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; resourceId?: InputMaybe<Scalars["String"]> }

Input for triggering usage sync

Type declaration

  • customerId: Scalars["String"]

    The customer id to trigger usage sync for

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The environment id to trigger usage sync for

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    The resource id to trigger usage sync for

TriggerWorkflowInput

TriggerWorkflowInput: { isTest?: InputMaybe<Scalars["Boolean"]>; payload?: InputMaybe<Scalars["JSON"]>; triggerId: Scalars["String"] }

Trigger workflow input

Type declaration

  • Optional isTest?: InputMaybe<Scalars["Boolean"]>

    If set to true, trigger the test workflow, otherwise trigger live workflow

  • Optional payload?: InputMaybe<Scalars["JSON"]>

    Workflow payload

  • triggerId: Scalars["String"]

    Trigger id

TypographyConfiguration

TypographyConfiguration: Omit<TypographyConfigurationFragment, "__typename">

TypographyConfigurationFragment

TypographyConfigurationFragment: { __typename?: "TypographyConfiguration"; body?: ({ __typename?: "FontVariant" } & FontVariantFragment) | null; fontFamily?: string | null; h1?: ({ __typename?: "FontVariant" } & FontVariantFragment) | null; h2?: ({ __typename?: "FontVariant" } & FontVariantFragment) | null; h3?: ({ __typename?: "FontVariant" } & FontVariantFragment) | null }

Type declaration

  • Optional __typename?: "TypographyConfiguration"
  • Optional body?: ({ __typename?: "FontVariant" } & FontVariantFragment) | null
  • Optional fontFamily?: string | null
  • Optional h1?: ({ __typename?: "FontVariant" } & FontVariantFragment) | null
  • Optional h2?: ({ __typename?: "FontVariant" } & FontVariantFragment) | null
  • Optional h3?: ({ __typename?: "FontVariant" } & FontVariantFragment) | null

TypographyConfigurationInput

TypographyConfigurationInput: { body?: InputMaybe<FontVariantInput>; fontFamily?: InputMaybe<Scalars["String"]>; h1?: InputMaybe<FontVariantInput>; h2?: InputMaybe<FontVariantInput>; h3?: InputMaybe<FontVariantInput> }

Input for setting typography styles for widgets.

Type declaration

UnArchiveFeatureGroupInput

UnArchiveFeatureGroupInput: { environmentId: Scalars["UUID"]; featureGroupId: Scalars["String"] }

Input for unarchiving a feature group

Type declaration

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • featureGroupId: Scalars["String"]

    The feature group id

UnArchiveFeatureInput

UnArchiveFeatureInput: { environmentId?: InputMaybe<Scalars["UUID"]>; id: Scalars["String"] }

Input for un-archiving a feature

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • id: Scalars["String"]

    Unique identifier for the entity

UnArchivePlanInput

UnArchivePlanInput: { environmentId?: InputMaybe<Scalars["UUID"]>; id: Scalars["String"] }

Input for un-archiving a plan

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • id: Scalars["String"]

    Plan ID to unarchive

UnArchiveProductInput

UnArchiveProductInput: { environmentId?: InputMaybe<Scalars["UUID"]>; refId: Scalars["String"] }

Input for unarchiving a product

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    Environment ID to unarchive the product in

  • refId: Scalars["String"]

    Product refId to unarchive

UnarchiveCustomerInput

UnarchiveCustomerInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]> }

Unarchive a customer

Type declaration

  • customerId: Scalars["String"]

    Customer slug

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

UnarchiveCustomerMutation

UnarchiveCustomerMutation: { __typename?: "Mutation"; unarchiveCustomer: { __typename?: "Customer" } & SlimCustomerFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • unarchiveCustomer: { __typename?: "Customer" } & SlimCustomerFragment

UnarchiveCustomerMutationVariables

UnarchiveCustomerMutationVariables: Exact<{ input: UnarchiveCustomerInput }>

UnarchiveEnvironmentInput

UnarchiveEnvironmentInput: { id?: InputMaybe<Scalars["String"]>; slug?: InputMaybe<Scalars["String"]> }

Input for unarchiving an environment

Type declaration

UnitTransformationInput

UnitTransformationInput: { divide: Scalars["Int"]; featureUnits?: InputMaybe<Scalars["String"]>; featureUnitsPlural?: InputMaybe<Scalars["String"]>; round?: InputMaybe<UnitTransformationRound> }

Input for unit transformation to be applied to the reported usage

Type declaration

UnitsInput

UnitsInput: { plural: Scalars["String"]; singular: Scalars["String"] }

Units input object (singular and plural)

Type declaration

  • plural: Scalars["String"]

    Plural form of the unit

  • singular: Scalars["String"]

    Singular form of the unit

UnlinkFeatureGroupFromPackageInput

UnlinkFeatureGroupFromPackageInput: { environmentId?: InputMaybe<Scalars["UUID"]>; featureGroupId: Scalars["UUID"]; packageId: Scalars["UUID"] }

Unlink feature group from package entitlements input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureGroupId: Scalars["UUID"]

    The group id to unlink

  • packageId: Scalars["UUID"]

    The unique identifier of the entitlement package

UnlinkPromotionalEntitlementsGroupInput

UnlinkPromotionalEntitlementsGroupInput: { customerId: Scalars["String"]; environmentId?: InputMaybe<Scalars["UUID"]>; featureGroupId: Scalars["String"] }

Unlink promotional feature group input

Type declaration

  • customerId: Scalars["String"]

    The unique identifier of the entitlement customer

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureGroupId: Scalars["String"]

    Feature group ID to unlink from promotional entitlements

UnlinkPromotionalEntitlementsGroupMutation

UnlinkPromotionalEntitlementsGroupMutation: { __typename?: "Mutation"; unlinkPromotionalEntitlementsGroup: ({ __typename?: "PromotionalEntitlement" } & PromotionalEntitlementFragment)[] }

Type declaration

UnlinkPromotionalEntitlementsGroupMutationVariables

UnlinkPromotionalEntitlementsGroupMutationVariables: Exact<{ input: UnlinkPromotionalEntitlementsGroupInput }>

UpdateAccountInput

UpdateAccountInput: { accessMethod?: InputMaybe<AccountAccessMethod>; accountEmailDomain?: InputMaybe<Scalars["String"]>; defaultSSORoles?: InputMaybe<DefaultSsoRolesInput>; displayName: Scalars["String"]; emailDomains?: InputMaybe<Scalars["String"][]>; subscriptionBillingAnchor?: InputMaybe<BillingAnchor>; subscriptionProrationBehavior?: InputMaybe<ProrationBehavior>; timezone?: InputMaybe<Scalars["String"]> }

Input type for updating an account

Type declaration

  • Optional accessMethod?: InputMaybe<AccountAccessMethod>

    The method of adding new members to this account

  • Optional accountEmailDomain?: InputMaybe<Scalars["String"]>

    This field is deprecated and replaced by EmailDomains to support multiple domains. Please use the emailDomains field instead.

  • Optional defaultSSORoles?: InputMaybe<DefaultSsoRolesInput>

    Default SSO roles for the account

  • displayName: Scalars["String"]

    The display name of the account

  • Optional emailDomains?: InputMaybe<Scalars["String"][]>

    Email domains to be used for sso and authorized domain configuration

  • Optional subscriptionBillingAnchor?: InputMaybe<BillingAnchor>

    The billing anchor for the subscription, e.g. "START_OF_THE_MONTH"

  • Optional subscriptionProrationBehavior?: InputMaybe<ProrationBehavior>

    The proration behavior for the subscription, e.g. "CREATE_PRORATIONS"

  • Optional timezone?: InputMaybe<Scalars["String"]>

    The timezone of the aaccount, e.g. "America/New_York"

UpdateCouponInput

UpdateCouponInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; description?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; name?: InputMaybe<Scalars["String"]>; refId: Scalars["String"] }

Update a coupon input

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Metadata associated with the entity

  • Optional description?: InputMaybe<Scalars["String"]>

    Description of the coupon

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional name?: InputMaybe<Scalars["String"]>

    Name of the coupon

  • refId: Scalars["String"]

    The unique identifier for the entity

UpdateCreditGrantInput

UpdateCreditGrantInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; comment?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; effectiveAt?: InputMaybe<Scalars["DateTime"]>; environmentId?: InputMaybe<Scalars["UUID"]>; expireAt?: InputMaybe<Scalars["DateTime"]>; id: Scalars["UUID"]; priority?: InputMaybe<Scalars["Float"]> }

Input for updating a credit grant

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Metadata associated with the entity

  • Optional comment?: InputMaybe<Scalars["String"]>

    The comment for the credit grant

  • Optional displayName?: InputMaybe<Scalars["String"]>

    The display name of the credit grant

  • Optional effectiveAt?: InputMaybe<Scalars["DateTime"]>

    The effective date of the credit grant

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional expireAt?: InputMaybe<Scalars["DateTime"]>

    The expiration date of the credit grant

  • id: Scalars["UUID"]

    The unique identifier for the credit grant

  • Optional priority?: InputMaybe<Scalars["Float"]>

    The priority of the credit grant

UpdateCustomCurrencyInput

UpdateCustomCurrencyInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; currencyId: Scalars["String"]; description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; symbol?: InputMaybe<Scalars["String"]>; units?: InputMaybe<UnitsInput> }

Input for updating a custom currency

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Metadata associated with the entity

  • currencyId: Scalars["String"]

    The unique identifier for the custom currency

  • Optional description?: InputMaybe<Scalars["String"]>

    Description of the currency

  • Optional displayName?: InputMaybe<Scalars["String"]>

    The name of the custom currency

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional symbol?: InputMaybe<Scalars["String"]>

    The symbol of the custom currency

  • Optional units?: InputMaybe<UnitsInput>

    Units for the currency (singular and plural)

UpdateCustomerInput

UpdateCustomerInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; awsMarketplaceCustomerId?: InputMaybe<Scalars["String"]>; billingId?: InputMaybe<Scalars["String"]>; billingInformation?: InputMaybe<CustomerBillingInfo>; couponRefId?: InputMaybe<Scalars["String"]>; crmId?: InputMaybe<Scalars["String"]>; customerId?: InputMaybe<Scalars["String"]>; email?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; name?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]>; salesforceId?: InputMaybe<Scalars["String"]>; shouldWaitSync?: InputMaybe<Scalars["Boolean"]> }

Update customer information

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Additional metadata update

  • Optional awsMarketplaceCustomerId?: InputMaybe<Scalars["String"]>

    The AWS Marketplace integration id

  • Optional billingId?: InputMaybe<Scalars["String"]>

    The unique identifier for the entity in the billing provider

  • Optional billingInformation?: InputMaybe<CustomerBillingInfo>

    Billing information update

  • Optional couponRefId?: InputMaybe<Scalars["String"]>

    Update a customer level coupon

  • Optional crmId?: InputMaybe<Scalars["String"]>

    The unique identifier for the customer in Hubspot integration

  • Optional customerId?: InputMaybe<Scalars["String"]>

    Customer slug

  • Optional email?: InputMaybe<Scalars["String"]>

    The email of the customer

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional name?: InputMaybe<Scalars["String"]>

    The name of the customer

  • Optional refId?: InputMaybe<Scalars["String"]>

    Customer slug

  • Optional salesforceId?: InputMaybe<Scalars["String"]>

    The unique identifier for the customer in Salesforce integration

  • Optional shouldWaitSync?: InputMaybe<Scalars["Boolean"]>

    Should wait for sync to complete before returning a response

UpdateCustomerMutation

UpdateCustomerMutation: { __typename?: "Mutation"; updateCustomer: { __typename?: "Customer" } & SlimCustomerFragment }

Type declaration

UpdateCustomerMutationVariables

UpdateCustomerMutationVariables: Exact<{ input: UpdateCustomerInput }>

UpdateExperimentInput

UpdateExperimentInput: { controlGroupName?: InputMaybe<Scalars["String"]>; description?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; name?: InputMaybe<Scalars["String"]>; productId?: InputMaybe<Scalars["String"]>; productSettings?: InputMaybe<ProductSettingsInput>; refId: Scalars["String"]; variantGroupName?: InputMaybe<Scalars["String"]>; variantPercentage?: InputMaybe<Scalars["Float"]> }

Input parameters for updating an existing experiment

Type declaration

  • Optional controlGroupName?: InputMaybe<Scalars["String"]>

    Name for the control group

  • Optional description?: InputMaybe<Scalars["String"]>

    Description of the experiements

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • Optional name?: InputMaybe<Scalars["String"]>

    Name of the experiment

  • Optional productId?: InputMaybe<Scalars["String"]>

    Internal identifier for the product experiment is associated with

  • Optional productSettings?: InputMaybe<ProductSettingsInput>

    Product settings for the variant group

  • refId: Scalars["String"]

    The unique identifier for the experiment

  • Optional variantGroupName?: InputMaybe<Scalars["String"]>

    Name for the variant group

  • Optional variantPercentage?: InputMaybe<Scalars["Float"]>

    Percentage of users in the variant group

UpdateFeatureInput

UpdateFeatureInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; description?: InputMaybe<Scalars["String"]>; displayName?: InputMaybe<Scalars["String"]>; enumConfiguration?: InputMaybe<EnumConfigurationEntityInput[]>; environmentId: Scalars["UUID"]; featureUnits?: InputMaybe<Scalars["String"]>; featureUnitsPlural?: InputMaybe<Scalars["String"]>; meter?: InputMaybe<CreateMeter>; refId: Scalars["String"]; unitTransformation?: InputMaybe<UnitTransformationInput> }

Input for updating a feature

Type declaration

UpdateHook

UpdateHook: { configuration?: InputMaybe<Scalars["JSON"]>; createdAt?: InputMaybe<Scalars["DateTime"]>; description?: InputMaybe<Scalars["String"]>; endpoint?: InputMaybe<Scalars["String"]>; environmentId?: InputMaybe<Scalars["UUID"]>; eventLogTypes?: InputMaybe<EventLogType[]>; id?: InputMaybe<Scalars["UUID"]>; secretKey?: InputMaybe<Scalars["String"]>; status?: InputMaybe<HookStatus> }

Type declaration

UpdateIntegrationInput

UpdateIntegrationInput: { auth0Credentials?: InputMaybe<Auth0CredentialsInput>; integrationId?: InputMaybe<Scalars["String"]>; isDefault?: InputMaybe<Scalars["Boolean"]>; openFGACredentials?: InputMaybe<OpenFgaCredentialsInput>; salesforceCredentials?: InputMaybe<SalesforceCredentialsInput>; snowflakeCredentials?: InputMaybe<SnowflakeCredentialsInput>; stripeCredentials?: InputMaybe<UpdateStripeCredentialsInput>; vendorIdentifier: VendorIdentifier; zuoraCredentials?: InputMaybe<ZuoraCredentialsInput> }

Update integration input

Type declaration

UpdateOfferInput

UpdateOfferInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; description?: InputMaybe<Scalars["String"]>; environmentId: Scalars["UUID"]; name?: InputMaybe<Scalars["String"]>; offerId: Scalars["String"] }

Update offer input

Type declaration

  • Optional additionalMetaData?: InputMaybe<Scalars["JSON"]>

    Metadata associated with the entity

  • Optional description?: InputMaybe<Scalars["String"]>

    Updated offer description

  • environmentId: Scalars["UUID"]

    The unique identifier for the environment

  • Optional name?: InputMaybe<Scalars["String"]>

    Updated offer name

  • offerId: Scalars["String"]

    The unique identifier for the entity

UpdateOneEnvironmentInput

UpdateOneEnvironmentInput: { id: Scalars["UUID"]; update: EnvironmentInput }

Type declaration

UpdateOneHookInput

UpdateOneHookInput: { id: Scalars["UUID"]; update: UpdateHook }

Type declaration

  • id: Scalars["UUID"]

    The id of the record to update

  • update: UpdateHook

    The update to apply.

UpdateOneIntegrationInput

UpdateOneIntegrationInput: { id: Scalars["UUID"]; update: UpdateIntegrationInput }

Type declaration

UpdateOnePackageEntitlementInput

UpdateOnePackageEntitlementInput: { id: Scalars["UUID"]; update: PackageEntitlementUpdateInput }

Type declaration

UpdateOneProductInput

UpdateOneProductInput: { id: Scalars["UUID"]; update: ProductUpdateInput }

Type declaration

UpdateOnePromotionalEntitlementInput

UpdateOnePromotionalEntitlementInput: { id: Scalars["UUID"]; update: PromotionalEntitlementUpdateInput }

Type declaration

UpdatePackageEntitlementInput

UpdatePackageEntitlementInput: { credit?: InputMaybe<PackageCreditEntitlementUpdateInput>; feature?: InputMaybe<PackageFeatureEntitlementUpdateInput>; id: Scalars["UUID"] }

Update package entitlement input

Type declaration

UpdatePackageEntitlementOrderInput

UpdatePackageEntitlementOrderInput: { entitlements: UpdatePackageEntitlementOrderItemInput[]; environmentId?: InputMaybe<Scalars["UUID"]>; packageId: Scalars["String"] }

Update package entitlement order input

Type declaration

UpdatePackageEntitlementOrderItemInput

UpdatePackageEntitlementOrderItemInput: { id: Scalars["UUID"]; order?: InputMaybe<Scalars["Float"]> }

Update package entitlement order item input

Type declaration

  • id: Scalars["UUID"]

    Unique identifier for the entity

  • Optional order?: InputMaybe<Scalars["Float"]>

    The order of the entitlement in the entitlement list

UpdateStripeCredentialsInput

UpdateStripeCredentialsInput: { isTaxEnabled?: InputMaybe<Scalars["Boolean"]> }

Input configuration for updating Stripe integration

Type declaration

  • Optional isTaxEnabled?: InputMaybe<Scalars["Boolean"]>

    Whether tax is enabled for the Stripe account

UpdateSubscriptionEntitlementInput

UpdateSubscriptionEntitlementInput: { featureId?: InputMaybe<Scalars["String"]>; hasSoftLimit?: InputMaybe<Scalars["Boolean"]>; hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>; id?: InputMaybe<Scalars["String"]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; resetPeriod?: InputMaybe<EntitlementResetPeriod>; usageLimit?: InputMaybe<Scalars["Float"]>; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Update subscription entitlement input

Type declaration

UpdateSubscriptionInput

UpdateSubscriptionInput: { additionalMetaData?: InputMaybe<Scalars["JSON"]>; addons?: InputMaybe<SubscriptionAddonInput[]>; appliedCoupon?: InputMaybe<SubscriptionCouponInput>; awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>; billableFeatures?: InputMaybe<BillableFeatureInput[]>; billingInformation?: InputMaybe<SubscriptionBillingInfo>; billingPeriod?: InputMaybe<BillingPeriod>; budget?: InputMaybe<BudgetConfigurationInput>; charges?: InputMaybe<ChargeInput[]>; environmentId?: InputMaybe<Scalars["UUID"]>; minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>; priceOverrides?: InputMaybe<PriceOverrideInput[]>; promotionCode?: InputMaybe<Scalars["String"]>; refId?: InputMaybe<Scalars["String"]>; scheduleStrategy?: InputMaybe<ScheduleStrategy>; subscriptionEntitlements?: InputMaybe<UpdateSubscriptionEntitlementInput[]>; subscriptionId?: InputMaybe<Scalars["String"]>; trialEndDate?: InputMaybe<Scalars["DateTime"]>; unitQuantity?: InputMaybe<Scalars["Float"]> }

Type declaration

UpdateSubscriptionMutation

UpdateSubscriptionMutation: { __typename?: "Mutation"; updateSubscription: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment }

Type declaration

UpdateSubscriptionMutationVariables

UpdateSubscriptionMutationVariables: Exact<{ input: UpdateSubscriptionInput }>

UpdateUserInput

UpdateUserInput: { department?: InputMaybe<Department>; name: Scalars["String"] }

Update the users information

Type declaration

UsageEventReportInput

UsageEventReportInput: { customerId: Scalars["String"]; dimensions?: InputMaybe<Scalars["JSON"]>; eventName: Scalars["String"]; idempotencyKey: Scalars["String"]; resourceId?: InputMaybe<Scalars["String"]>; timestamp?: InputMaybe<Scalars["DateTime"]> }

Input parameters for reporting usage events

Type declaration

UsageEventsInput

UsageEventsInput: { customerId?: InputMaybe<Scalars["String"]>; environmentId: Scalars["UUID"]; filters?: InputMaybe<MeterFilterDefinitionInput[]> }

Input for usage events

Type declaration

UsageEventsReportInput

UsageEventsReportInput: { environmentId?: InputMaybe<Scalars["UUID"]>; usageEvents: UsageEventReportInput[] }

Input parameters for reporting usage events

Type declaration

UsageHistoryFragment

UsageHistoryFragment: { __typename?: "UsageHistory"; endDate?: any | null; groups?: { __typename?: "GroupUsageHistory"; groupInfo: { __typename?: "GroupInfo"; key: string; value: string }[]; usageMeasurements: { __typename?: "UsageMeasurementPoint"; date: any; isResetPoint: boolean; value: number }[] }[] | null; markers: { __typename?: "UsageMarker"; timestamp: any; type: UsageMarkerType }[]; startDate: any; usageMeasurements: { __typename?: "UsageMeasurementPoint"; date: any; isResetPoint: boolean; value: number }[] }

Type declaration

  • Optional __typename?: "UsageHistory"
  • Optional endDate?: any | null
  • Optional groups?: { __typename?: "GroupUsageHistory"; groupInfo: { __typename?: "GroupInfo"; key: string; value: string }[]; usageMeasurements: { __typename?: "UsageMeasurementPoint"; date: any; isResetPoint: boolean; value: number }[] }[] | null
  • markers: { __typename?: "UsageMarker"; timestamp: any; type: UsageMarkerType }[]
  • startDate: any
  • usageMeasurements: { __typename?: "UsageMeasurementPoint"; date: any; isResetPoint: boolean; value: number }[]

UsageHistoryInput

UsageHistoryInput: { customerRefId: Scalars["String"]; endDate?: InputMaybe<Scalars["DateTime"]>; environmentId?: InputMaybe<Scalars["UUID"]>; featureRefId: Scalars["String"]; groupBy?: InputMaybe<Scalars["String"][]>; monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>; resetPeriod?: InputMaybe<EntitlementResetPeriod>; resourceRefId?: InputMaybe<Scalars["String"]>; startDate: Scalars["DateTime"]; weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>; yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput> }

Input parameters for retrieving usage history

Type declaration

UsageHistoryPoint

UsageHistoryPoint: { date: Date; isResetPoint: boolean; value: number }

Type declaration

  • date: Date
  • isResetPoint: boolean
  • value: number

UsageHistoryV2Fragment

UsageHistoryV2Fragment: { __typename?: "UsageHistoryV2"; markers: { __typename?: "UsageMarker"; timestamp: any; type: UsageMarkerType }[]; series: { __typename?: "UsageHistorySeries"; points: { __typename?: "UsageHistoryPoint"; isResetPoint: boolean; timestamp: any; value: number }[]; tags: { __typename?: "UsageHistorySeriesTag"; key: string; value: string }[] }[] }

Type declaration

  • Optional __typename?: "UsageHistoryV2"
  • markers: { __typename?: "UsageMarker"; timestamp: any; type: UsageMarkerType }[]
  • series: { __typename?: "UsageHistorySeries"; points: { __typename?: "UsageHistoryPoint"; isResetPoint: boolean; timestamp: any; value: number }[]; tags: { __typename?: "UsageHistorySeriesTag"; key: string; value: string }[] }[]

UsageHistoryV2Input

UsageHistoryV2Input: { customerId: Scalars["String"]; endDate?: InputMaybe<Scalars["DateTime"]>; environmentId?: InputMaybe<Scalars["UUID"]>; featureId: Scalars["String"]; groupBy?: InputMaybe<Scalars["String"][]>; resourceId?: InputMaybe<Scalars["String"]>; startDate: Scalars["DateTime"] }

Input parameters for retrieving usage history

Type declaration

  • customerId: Scalars["String"]

    Customer id

  • Optional endDate?: InputMaybe<Scalars["DateTime"]>

    The end date of the range

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureId: Scalars["String"]

    Feature id

  • Optional groupBy?: InputMaybe<Scalars["String"][]>

    Criteria by which to group the usage history

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    Resource id

  • startDate: Scalars["DateTime"]

    The start date of the range

UsageMeasurementCreateInput

UsageMeasurementCreateInput: { createdAt?: InputMaybe<Scalars["DateTime"]>; customerId: Scalars["String"]; dimensions?: InputMaybe<Scalars["JSON"]>; environmentId?: InputMaybe<Scalars["UUID"]>; featureId: Scalars["String"]; resourceId?: InputMaybe<Scalars["String"]>; updateBehavior?: InputMaybe<UsageUpdateBehavior>; value: Scalars["Float"] }

Input for creating a usage measurement

Type declaration

  • Optional createdAt?: InputMaybe<Scalars["DateTime"]>

    Timestamp of when the record was created

  • customerId: Scalars["String"]

    Customer id

  • Optional dimensions?: InputMaybe<Scalars["JSON"]>

    Additional dimensions for the usage report

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • featureId: Scalars["String"]

    Feature id

  • Optional resourceId?: InputMaybe<Scalars["String"]>

    Resource id

  • Optional updateBehavior?: InputMaybe<UsageUpdateBehavior>

    The method by which the usage value should be updated

  • value: Scalars["Float"]

    The value to report for usage

UsageMeasurementFilter

UsageMeasurementFilter: { and?: InputMaybe<UsageMeasurementFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; customer?: InputMaybe<UsageMeasurementFilterCustomerFilter>; environmentId?: InputMaybe<UuidFilterComparison>; feature?: InputMaybe<UsageMeasurementFilterFeatureFilter>; id?: InputMaybe<UuidFilterComparison>; or?: InputMaybe<UsageMeasurementFilter[]> }

Type declaration

UsageMeasurementFilterCustomerFilter

UsageMeasurementFilterCustomerFilter: { and?: InputMaybe<UsageMeasurementFilterCustomerFilter[]>; awsMarketplaceCustomerId?: InputMaybe<StringFieldComparison>; billingId?: InputMaybe<StringFieldComparison>; createdAt?: InputMaybe<DateFieldComparison>; crmHubspotCompanyId?: InputMaybe<StringFieldComparison>; crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>; crmId?: InputMaybe<StringFieldComparison>; customerId?: InputMaybe<StringFieldComparison>; deletedAt?: InputMaybe<DateFieldComparison>; email?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; id?: InputMaybe<UuidFilterComparison>; name?: InputMaybe<StringFieldComparison>; or?: InputMaybe<UsageMeasurementFilterCustomerFilter[]>; refId?: InputMaybe<StringFieldComparison>; salesforceId?: InputMaybe<StringFieldComparison>; searchQuery?: InputMaybe<CustomerSearchQueryFilterComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

UsageMeasurementFilterFeatureFilter

UsageMeasurementFilterFeatureFilter: { and?: InputMaybe<UsageMeasurementFilterFeatureFilter[]>; createdAt?: InputMaybe<DateFieldComparison>; description?: InputMaybe<StringFieldComparison>; displayName?: InputMaybe<StringFieldComparison>; environmentId?: InputMaybe<UuidFilterComparison>; featureStatus?: InputMaybe<FeatureStatusFilterComparison>; featureType?: InputMaybe<FeatureTypeFilterComparison>; id?: InputMaybe<UuidFilterComparison>; meterType?: InputMaybe<MeterTypeFilterComparison>; or?: InputMaybe<UsageMeasurementFilterFeatureFilter[]>; refId?: InputMaybe<StringFieldComparison>; updatedAt?: InputMaybe<DateFieldComparison> }

Type declaration

UsageMeasurementSort

UsageMeasurementSort: { direction: SortDirection; field: UsageMeasurementSortFields; nulls?: InputMaybe<SortNulls> }

Type declaration

UsageUpdatedFragment

UsageUpdatedFragment: { __typename?: "UsageMeasurementUpdated"; currentUsage: number; customerId: string; featureId: string; nextResetDate?: number | null; resourceId?: string | null; usagePeriodEnd?: number | null; usagePeriodStart?: number | null }

Type declaration

  • Optional __typename?: "UsageMeasurementUpdated"
  • currentUsage: number
  • customerId: string
  • featureId: string
  • Optional nextResetDate?: number | null
  • Optional resourceId?: string | null
  • Optional usagePeriodEnd?: number | null
  • Optional usagePeriodStart?: number | null

UuidFilterComparison

UuidFilterComparison: { eq?: InputMaybe<Scalars["UUID"]>; gt?: InputMaybe<Scalars["UUID"]>; gte?: InputMaybe<Scalars["UUID"]>; iLike?: InputMaybe<Scalars["UUID"]>; in?: InputMaybe<Scalars["UUID"][]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<Scalars["UUID"]>; lt?: InputMaybe<Scalars["UUID"]>; lte?: InputMaybe<Scalars["UUID"]>; neq?: InputMaybe<Scalars["UUID"]>; notILike?: InputMaybe<Scalars["UUID"]>; notIn?: InputMaybe<Scalars["UUID"][]>; notLike?: InputMaybe<Scalars["UUID"]> }

Type declaration

ValidateMergeEnvironmentInput

ValidateMergeEnvironmentInput: { destinationEnvironmentSlug: Scalars["String"]; mergeConfiguration?: InputMaybe<EnvironmentMergeConfigurationInput>; sourceEnvironmentSlug: Scalars["String"] }

Input type for validateMergeEnvironment query

Type declaration

  • destinationEnvironmentSlug: Scalars["String"]

    Slug of the destination environment

  • Optional mergeConfiguration?: InputMaybe<EnvironmentMergeConfigurationInput>

    Optional configuration to customize how the validation is performed

  • sourceEnvironmentSlug: Scalars["String"]

    Slug of the source environment

VendorIdentifierFilterComparison

VendorIdentifierFilterComparison: { eq?: InputMaybe<VendorIdentifier>; gt?: InputMaybe<VendorIdentifier>; gte?: InputMaybe<VendorIdentifier>; iLike?: InputMaybe<VendorIdentifier>; in?: InputMaybe<VendorIdentifier[]>; is?: InputMaybe<Scalars["Boolean"]>; isNot?: InputMaybe<Scalars["Boolean"]>; like?: InputMaybe<VendorIdentifier>; lt?: InputMaybe<VendorIdentifier>; lte?: InputMaybe<VendorIdentifier>; neq?: InputMaybe<VendorIdentifier>; notILike?: InputMaybe<VendorIdentifier>; notIn?: InputMaybe<VendorIdentifier[]>; notLike?: InputMaybe<VendorIdentifier> }

Type declaration

VoidCreditGrantInput

VoidCreditGrantInput: { environmentId?: InputMaybe<Scalars["UUID"]>; id: Scalars["String"] }

Input for voiding a credit grant

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

  • id: Scalars["String"]

    The ID of the credit grant to void

VoidCreditGrantMutation

VoidCreditGrantMutation: { __typename?: "Mutation"; voidCreditGrant: { __typename?: "CreditGrant" } & CreditGrantFragment }

Type declaration

  • Optional __typename?: "Mutation"
  • voidCreditGrant: { __typename?: "CreditGrant" } & CreditGrantFragment

VoidCreditGrantMutationVariables

VoidCreditGrantMutationVariables: Exact<{ input: VoidCreditGrantInput }>

WaitForCheckoutCompleted

WaitForCheckoutCompleted: { refreshOnComplete?: boolean; timeoutMs?: number }

Type declaration

  • Optional refreshOnComplete?: boolean
  • Optional timeoutMs?: number

WeeklyResetPeriodConfigInput

WeeklyResetPeriodConfigInput: { accordingTo: WeeklyAccordingTo }

Weekly reset period config input

Type declaration

WidgetConfigurationUpdateInput

WidgetConfigurationUpdateInput: { checkoutConfiguration?: InputMaybe<CheckoutConfigurationInput>; customerPortalConfiguration?: InputMaybe<CustomerPortalConfigurationInput>; environmentId?: InputMaybe<Scalars["UUID"]>; paywallConfiguration?: InputMaybe<PaywallConfigurationInput> }

Input for updating configuration settings across all widgets.

Type declaration

WorkflowsLoginInput

WorkflowsLoginInput: { environmentId?: InputMaybe<Scalars["UUID"]> }

Workflow login input

Type declaration

  • Optional environmentId?: InputMaybe<Scalars["UUID"]>

    The unique identifier for the environment

YearlyResetPeriodConfigInput

YearlyResetPeriodConfigInput: { accordingTo: YearlyAccordingTo }

Yearly reset period config input

Type declaration

ZuoraCheckoutCredentialsFragment

ZuoraCheckoutCredentialsFragment: { __typename?: "ZuoraCheckoutCredentials"; publishableKey: string }

Type declaration

  • Optional __typename?: "ZuoraCheckoutCredentials"
  • publishableKey: string

ZuoraCredentialsInput

ZuoraCredentialsInput: { baseUrl: Scalars["String"]; clientId: Scalars["String"]; clientSecret: Scalars["String"]; deferredRevenueAccount?: InputMaybe<Scalars["String"]>; invoiceSettlementEnabled?: InputMaybe<Scalars["Boolean"]>; paymentGatewayId?: InputMaybe<Scalars["String"]>; paymentPageId?: InputMaybe<Scalars["String"]>; publishableKey?: InputMaybe<Scalars["String"]>; recognizedRevenueAccount?: InputMaybe<Scalars["String"]>; stripePublishableKey?: InputMaybe<Scalars["String"]>; stripeSecretKey?: InputMaybe<Scalars["String"]> }

Input configuration for Zuora integration

Type declaration

  • baseUrl: Scalars["String"]

    REST Base URL of the Zuora account

  • clientId: Scalars["String"]

    Client ID for the Zuora account

  • clientSecret: Scalars["String"]

    Client secret for the Zuora account

  • Optional deferredRevenueAccount?: InputMaybe<Scalars["String"]>

    The deferred revenue account code

  • Optional invoiceSettlementEnabled?: InputMaybe<Scalars["Boolean"]>

    Whether invoice settlement is enabled

  • Optional paymentGatewayId?: InputMaybe<Scalars["String"]>

    The ID of the payment gateway to use

  • Optional paymentPageId?: InputMaybe<Scalars["String"]>

    The ID of the payment page to use

  • Optional publishableKey?: InputMaybe<Scalars["String"]>

    Publishable key for the Zuora payment form

  • Optional recognizedRevenueAccount?: InputMaybe<Scalars["String"]>

    The revenue recognition account code

  • Optional stripePublishableKey?: InputMaybe<Scalars["String"]>

    Stripe publishable key for the Zuora payment page

  • Optional stripeSecretKey?: InputMaybe<Scalars["String"]>

    Stripe secret key for the Zuora payment page

Variables

Const AddonDependencyFragmentDoc

AddonDependencyFragmentDoc: DocumentNode

Const AddonFragmentDoc

AddonFragmentDoc: DocumentNode

Const ApplySubscriptionDocument

ApplySubscriptionDocument: DocumentNode

Const ApplySubscriptionFragmentDoc

ApplySubscriptionFragmentDoc: DocumentNode

Const ArchiveCustomerDocument

ArchiveCustomerDocument: DocumentNode

Const AutoRechargeSettingsFragmentDoc

AutoRechargeSettingsFragmentDoc: DocumentNode

Const CancelSubscriptionDocument

CancelSubscriptionDocument: DocumentNode

Const CancelSubscriptionUpdatesDocument

CancelSubscriptionUpdatesDocument: DocumentNode

Const CheckoutConfigurationFragmentDoc

CheckoutConfigurationFragmentDoc: DocumentNode

Const CheckoutStateFragmentDoc

CheckoutStateFragmentDoc: DocumentNode

Const CouponFragmentDoc

CouponFragmentDoc: DocumentNode

Const CreateCouponDocument

CreateCouponDocument: DocumentNode

Const CreatePaymentSessionDocument

CreatePaymentSessionDocument: DocumentNode

Const CreateSubscriptionDocument

CreateSubscriptionDocument: DocumentNode

Const CreditBalanceFragmentDoc

CreditBalanceFragmentDoc: DocumentNode

Const CreditBalanceUpdatedPayloadFragmentDoc

CreditBalanceUpdatedPayloadFragmentDoc: DocumentNode

Const CreditGrantFragmentDoc

CreditGrantFragmentDoc: DocumentNode

Const CreditGrantInvoiceFragmentDoc

CreditGrantInvoiceFragmentDoc: DocumentNode

Const CreditLedgerFragmentDoc

CreditLedgerFragmentDoc: DocumentNode

Const CreditUsageFragmentDoc

CreditUsageFragmentDoc: DocumentNode

Const CreditsBalanceSummaryFragmentDoc

CreditsBalanceSummaryFragmentDoc: DocumentNode

Const CustomerFragmentDoc

CustomerFragmentDoc: DocumentNode

Const CustomerPortalBillingInformationFragmentDoc

CustomerPortalBillingInformationFragmentDoc: DocumentNode

Const CustomerPortalConfigurationFragmentDoc

CustomerPortalConfigurationFragmentDoc: DocumentNode

Const CustomerPortalEntitlementFragmentDoc

CustomerPortalEntitlementFragmentDoc: DocumentNode

Const CustomerPortalFragmentDoc

CustomerPortalFragmentDoc: DocumentNode

Const CustomerPortalPromotionalEntitlementFragmentDoc

CustomerPortalPromotionalEntitlementFragmentDoc: DocumentNode

Const CustomerPortalSubscriptionAddonFragmentDoc

CustomerPortalSubscriptionAddonFragmentDoc: DocumentNode

Const CustomerPortalSubscriptionFragmentDoc

CustomerPortalSubscriptionFragmentDoc: DocumentNode

Const CustomerPortalSubscriptionPriceFragmentDoc

CustomerPortalSubscriptionPriceFragmentDoc: DocumentNode

Const CustomerPortalSubscriptionScheduledUpdateDataFragmentDoc

CustomerPortalSubscriptionScheduledUpdateDataFragmentDoc: DocumentNode

Const CustomerResourceFragmentDoc

CustomerResourceFragmentDoc: DocumentNode

Const CustomerStatisticsFragmentDoc

CustomerStatisticsFragmentDoc: DocumentNode

Const CustomerWithSubscriptionsFragmentDoc

CustomerWithSubscriptionsFragmentDoc: DocumentNode

Const DelegateSubscriptionToCustomerDocument

DelegateSubscriptionToCustomerDocument: DocumentNode

Const DetachCustomerPaymentMethodDocument

DetachCustomerPaymentMethodDocument: DocumentNode

Const EntitlementFragmentDoc

EntitlementFragmentDoc: DocumentNode

Const EntitlementUsageUpdatedFragmentDoc

EntitlementUsageUpdatedFragmentDoc: DocumentNode

Const EntitlementsUpdatedPayloadFragmentDoc

EntitlementsUpdatedPayloadFragmentDoc: DocumentNode

Const EstimateSubscriptionDocument

EstimateSubscriptionDocument: DocumentNode

Const EstimateSubscriptionUpdateDocument

EstimateSubscriptionUpdateDocument: DocumentNode

Const FeatureFragmentDoc

FeatureFragmentDoc: DocumentNode

Const FontVariantFragmentDoc

FontVariantFragmentDoc: DocumentNode

Const GetActiveSubscriptionsDocument

GetActiveSubscriptionsDocument: DocumentNode

Const GetActiveSubscriptionsListDocument

GetActiveSubscriptionsListDocument: DocumentNode

Const GetAutomaticRechargeConfigurationDocument

GetAutomaticRechargeConfigurationDocument: DocumentNode

Const GetCheckoutStateDocument

GetCheckoutStateDocument: DocumentNode

Const GetCouponsDocument

GetCouponsDocument: DocumentNode

Const GetCreditBalanceDocument

GetCreditBalanceDocument: DocumentNode

Const GetCreditGrantsDocument

GetCreditGrantsDocument: DocumentNode

Const GetCreditLedgerDocument

GetCreditLedgerDocument: DocumentNode

Const GetCreditUsageDocument

GetCreditUsageDocument: DocumentNode

Const GetCustomerByIdDocument

GetCustomerByIdDocument: DocumentNode

Const GetCustomerPortalByRefIdDocument

GetCustomerPortalByRefIdDocument: DocumentNode

Const GetCustomerStatisticsDocument

GetCustomerStatisticsDocument: DocumentNode

Const GetEntitlementDocument

GetEntitlementDocument: DocumentNode

Const GetEntitlementsDocument

GetEntitlementsDocument: DocumentNode

Const GetEntitlementsStateDocument

GetEntitlementsStateDocument: DocumentNode

Const GetMockPaywallDocument

GetMockPaywallDocument: DocumentNode

Const GetPaywallDocument

GetPaywallDocument: DocumentNode

Const GetProductsDocument

GetProductsDocument: DocumentNode

Const GetSdkConfigurationDocument

GetSdkConfigurationDocument: DocumentNode

Const GetSubscriptionDocument

GetSubscriptionDocument: DocumentNode

Const GetSubscriptionsDocument

GetSubscriptionsDocument: DocumentNode

Const GetUsageHistoryDocument

GetUsageHistoryDocument: DocumentNode

Const GetUsageHistoryV2Document

GetUsageHistoryV2Document: DocumentNode

Const GrantCreditsDocument

GrantCreditsDocument: DocumentNode

Const GrantPromotionalEntitlementsDocument

GrantPromotionalEntitlementsDocument: DocumentNode

Const GrantPromotionalEntitlementsGroupDocument

GrantPromotionalEntitlementsGroupDocument: DocumentNode

Const ImmediateSubscriptionPreviewInvoiceFragmentDoc

ImmediateSubscriptionPreviewInvoiceFragmentDoc: DocumentNode

Const ImportCustomerBulkDocument

ImportCustomerBulkDocument: DocumentNode

Const ImportCustomerDocument

ImportCustomerDocument: DocumentNode

Const ImportSubscriptionsBulkDocument

ImportSubscriptionsBulkDocument: DocumentNode

Const LayoutConfigurationFragmentDoc

LayoutConfigurationFragmentDoc: DocumentNode

Const MigrateSubscriptionToLatestDocument

MigrateSubscriptionToLatestDocument: DocumentNode

Const MockPaywallAddonDependencyFragmentDoc

MockPaywallAddonDependencyFragmentDoc: DocumentNode

Const MockPaywallAddonFragmentDoc

MockPaywallAddonFragmentDoc: DocumentNode

Const MockPaywallPackageEntitlementFragmentDoc

MockPaywallPackageEntitlementFragmentDoc: DocumentNode

Const MockPaywallPlanCompatiblePackageGroupsFragmentDoc

MockPaywallPlanCompatiblePackageGroupsFragmentDoc: DocumentNode

Const MockPaywallPlanFragmentDoc

MockPaywallPlanFragmentDoc: DocumentNode

Const MockPaywallPriceFragmentDoc

MockPaywallPriceFragmentDoc: DocumentNode

Const OnCreditBalanceUpdatedDocument

OnCreditBalanceUpdatedDocument: DocumentNode

Const OnEntitlementsUpdatedDocument

OnEntitlementsUpdatedDocument: DocumentNode

Const OnPackagePublishedDocument

OnPackagePublishedDocument: DocumentNode

Const OnUsageUpdatedDocument

OnUsageUpdatedDocument: DocumentNode

Const OveragePriceFragmentDoc

OveragePriceFragmentDoc: DocumentNode

Const PackageEntitlementFragmentDoc

PackageEntitlementFragmentDoc: DocumentNode

Const PackagePublishedPayloadFragmentDoc

PackagePublishedPayloadFragmentDoc: DocumentNode

Const PageInfoFragmentDoc

PageInfoFragmentDoc: DocumentNode

Const PaymentSessionFragmentDoc

PaymentSessionFragmentDoc: DocumentNode

Const PaywallCalculatedPricePointsFragmentDoc

PaywallCalculatedPricePointsFragmentDoc: DocumentNode

Const PaywallConfigurationFragmentDoc

PaywallConfigurationFragmentDoc: DocumentNode

Const PaywallCurrencyFragmentDoc

PaywallCurrencyFragmentDoc: DocumentNode

Const PaywallFragmentDoc

PaywallFragmentDoc: DocumentNode

Const PlanCompatiblePackageGroupsFragmentDoc

PlanCompatiblePackageGroupsFragmentDoc: DocumentNode

Const PlanFragmentDoc

PlanFragmentDoc: DocumentNode

Const PreviewNextInvoiceDocument

PreviewNextInvoiceDocument: DocumentNode

Const PreviewSubscriptionDocument

PreviewSubscriptionDocument: DocumentNode

Const PriceFragmentDoc

PriceFragmentDoc: DocumentNode

Const PriceTierFragmentDoc

PriceTierFragmentDoc: DocumentNode

Const ProductFragmentDoc

ProductFragmentDoc: DocumentNode

Const PromotionalEntitlementFragmentDoc

PromotionalEntitlementFragmentDoc: DocumentNode

Const ProvisionCustomerDocument

ProvisionCustomerDocument: DocumentNode

Const ProvisionCustomerFragmentDoc

ProvisionCustomerFragmentDoc: DocumentNode

Const ProvisionSubscriptionDocument

ProvisionSubscriptionDocument: DocumentNode

Const ProvisionSubscriptionFragmentDoc

ProvisionSubscriptionFragmentDoc: DocumentNode

Const ReportEntitlementCheckRequestedDocument

ReportEntitlementCheckRequestedDocument: DocumentNode

Const ReportEventDocument

ReportEventDocument: DocumentNode

Const ReportUsageBulkDocument

ReportUsageBulkDocument: DocumentNode

Const ReportUsageDocument

ReportUsageDocument: DocumentNode

Const ReportUsageFragmentDoc

ReportUsageFragmentDoc: DocumentNode

Const ResetPeriodConfigurationFragmentDoc

ResetPeriodConfigurationFragmentDoc: DocumentNode

Const RevokePromotionalEntitlementDocument

RevokePromotionalEntitlementDocument: DocumentNode

Const RevokePromotionalEntitlementsGroupDocument

RevokePromotionalEntitlementsGroupDocument: DocumentNode

Const SaveAutomaticRechargeConfigurationDocument

SaveAutomaticRechargeConfigurationDocument: DocumentNode

Const ScheduleVariablesFragmentDoc

ScheduleVariablesFragmentDoc: DocumentNode

Const SlimCustomCurrencyFragmentDoc

SlimCustomCurrencyFragmentDoc: DocumentNode

Const SlimCustomerFragmentDoc

SlimCustomerFragmentDoc: DocumentNode

Const SlimSubscriptionFragmentDoc

SlimSubscriptionFragmentDoc: DocumentNode

Const SlimSubscriptionFragmentV2FragmentDoc

SlimSubscriptionFragmentV2FragmentDoc: DocumentNode

Const StripeCheckoutCredentialsFragmentDoc

StripeCheckoutCredentialsFragmentDoc: DocumentNode

Const SubscriptionFragmentDoc

SubscriptionFragmentDoc: DocumentNode

Const SubscriptionFutureUpdateDataFragmentDoc

SubscriptionFutureUpdateDataFragmentDoc: DocumentNode

Const SubscriptionInvoiceFragmentDoc

SubscriptionInvoiceFragmentDoc: DocumentNode

Const SubscriptionInvoicePreviewFragmentDoc

SubscriptionInvoicePreviewFragmentDoc: DocumentNode

Const SubscriptionPreviewFragmentDoc

SubscriptionPreviewFragmentDoc: DocumentNode

Const SubscriptionPreviewInvoiceFragmentDoc

SubscriptionPreviewInvoiceFragmentDoc: DocumentNode

Const SubscriptionPreviewV2FragmentDoc

SubscriptionPreviewV2FragmentDoc: DocumentNode

Const SubscriptionQueryFragmentDoc

SubscriptionQueryFragmentDoc: DocumentNode

Const SubscriptionScheduledUpdateDataFragmentDoc

SubscriptionScheduledUpdateDataFragmentDoc: DocumentNode

Const SubscriptionTrialConfigurationFragmentDoc

SubscriptionTrialConfigurationFragmentDoc: DocumentNode

Const TotalPriceFragmentDoc

TotalPriceFragmentDoc: DocumentNode

Const TransferSubscriptionDocument

TransferSubscriptionDocument: DocumentNode

Const TransferSubscriptionToResourceDocument

TransferSubscriptionToResourceDocument: DocumentNode

Const TypographyConfigurationFragmentDoc

TypographyConfigurationFragmentDoc: DocumentNode

Const UnarchiveCustomerDocument

UnarchiveCustomerDocument: DocumentNode

Const UnlinkPromotionalEntitlementsGroupDocument

UnlinkPromotionalEntitlementsGroupDocument: DocumentNode

Const UpdateCustomerDocument

UpdateCustomerDocument: DocumentNode

Const UpdateSubscriptionDocument

UpdateSubscriptionDocument: DocumentNode

Const UsageHistoryFragmentDoc

UsageHistoryFragmentDoc: DocumentNode

Const UsageHistoryV2FragmentDoc

UsageHistoryV2FragmentDoc: DocumentNode

Const UsageUpdatedFragmentDoc

UsageUpdatedFragmentDoc: DocumentNode

Const VoidCreditGrantDocument

VoidCreditGrantDocument: DocumentNode

Const ZuoraCheckoutCredentialsFragmentDoc

ZuoraCheckoutCredentialsFragmentDoc: DocumentNode

Functions

getSdk

  • getSdk(client: GraphQLClient, withWrapper?: SdkFunctionWrapper): { ApplySubscription: any; ArchiveCustomer: any; CancelSubscription: any; CancelSubscriptionUpdates: any; CreateCoupon: any; CreatePaymentSession: any; CreateSubscription: any; DelegateSubscriptionToCustomer: any; DetachCustomerPaymentMethod: any; EstimateSubscription: any; EstimateSubscriptionUpdate: any; GetActiveSubscriptions: any; GetActiveSubscriptionsList: any; GetAutomaticRechargeConfiguration: any; GetCheckoutState: any; GetCoupons: any; GetCreditBalance: any; GetCreditGrants: any; GetCreditLedger: any; GetCreditUsage: any; GetCustomerById: any; GetCustomerPortalByRefId: any; GetCustomerStatistics: any; GetEntitlement: any; GetEntitlements: any; GetEntitlementsState: any; GetMockPaywall: any; GetPaywall: any; GetProducts: any; GetSdkConfiguration: any; GetSubscription: any; GetSubscriptions: any; GetUsageHistory: any; GetUsageHistoryV2: any; GrantCredits: any; GrantPromotionalEntitlements: any; GrantPromotionalEntitlementsGroup: any; ImportCustomer: any; ImportCustomerBulk: any; ImportSubscriptionsBulk: any; MigrateSubscriptionToLatest: any; OnCreditBalanceUpdated: any; OnEntitlementsUpdated: any; OnPackagePublished: any; OnUsageUpdated: any; PreviewNextInvoice: any; PreviewSubscription: any; ProvisionCustomer: any; ProvisionSubscription: any; ReportEntitlementCheckRequested: any; ReportEvent: any; ReportUsage: any; ReportUsageBulk: any; RevokePromotionalEntitlement: any; RevokePromotionalEntitlementsGroup: any; SaveAutomaticRechargeConfiguration: any; TransferSubscription: any; TransferSubscriptionToResource: any; UnarchiveCustomer: any; UnlinkPromotionalEntitlementsGroup: any; UpdateCustomer: any; UpdateSubscription: any; VoidCreditGrant: any }

Generated using TypeDoc