Type Alias SubscriptionInput

type SubscriptionInput = {
    additionalMetaData?: InputMaybe<Scalars["JSON"]>;
    addons?: InputMaybe<SubscriptionAddonInput[]>;
    appliedCoupon?: InputMaybe<SubscriptionCouponInput>;
    awaitPaymentConfirmation?: InputMaybe<Scalars["Boolean"]>;
    billableFeatures?: InputMaybe<BillableFeatureInput[]>;
    billingCountryCode?: InputMaybe<Scalars["String"]>;
    billingCycleAnchor?: InputMaybe<SubscriptionBillingCycleAnchor>;
    billingId?: InputMaybe<Scalars["String"]>;
    billingInformation?: InputMaybe<Types.SubscriptionBillingInfo>;
    billingPeriod?: InputMaybe<BillingPeriod>;
    budget?: InputMaybe<BudgetConfigurationInput>;
    cancellationDate?: InputMaybe<Scalars["DateTime"]>;
    charges?: InputMaybe<ChargeInput[]>;
    crmId?: InputMaybe<Scalars["String"]>;
    customerId: Scalars["String"];
    endDate?: InputMaybe<Scalars["DateTime"]>;
    entitlements?: InputMaybe<SubscriptionEntitlementInputV2[]>;
    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"]>;
}

Properties

`Optional`additionalMetaData

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

`Optional`addons

addons?: InputMaybe<SubscriptionAddonInput[]>

`Optional`appliedCoupon

appliedCoupon?: InputMaybe<SubscriptionCouponInput>

Coupon input

`Optional`awaitPaymentConfirmation

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

`Optional`billableFeatures

billableFeatures?: InputMaybe<BillableFeatureInput[]>

`Optional`billingCountryCode

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

`Optional`billingCycleAnchor

billingCycleAnchor?: InputMaybe<SubscriptionBillingCycleAnchor>

Billing cycle anchor behavior for the subscription

`Optional`billingId

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

`Optional`billingInformation

billingInformation?: InputMaybe<Types.SubscriptionBillingInfo>

`Optional`billingPeriod

billingPeriod?: InputMaybe<BillingPeriod>

`Optional`budget

budget?: InputMaybe<BudgetConfigurationInput>

Budget configuration

`Optional`cancellationDate

cancellationDate?: InputMaybe<Scalars["DateTime"]>

Subscription cancellation date

`Optional`charges

charges?: InputMaybe<ChargeInput[]>

`Optional`crmId

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

customerId

customerId: Scalars["String"]

`Optional`endDate

endDate?: InputMaybe<Scalars["DateTime"]>

`Optional`entitlements

entitlements?: InputMaybe<SubscriptionEntitlementInputV2[]>

`Optional`environmentId

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

`Optional`isCustomPriceSubscription

isCustomPriceSubscription?: InputMaybe<Scalars["Boolean"]>

`Optional`isOverridingTrialConfig

isOverridingTrialConfig?: InputMaybe<Scalars["Boolean"]>

`Optional`isTrial

isTrial?: InputMaybe<Scalars["Boolean"]>

`Optional`minimumSpend

minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>

The minimum spend configuration

`Optional`payingCustomerId

payingCustomerId?: InputMaybe<Scalars["String"]>

`Optional`paymentCollectionMethod

paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>

Subscription payment collection method

planId

planId: Scalars["String"]

`Optional`priceOverrides

priceOverrides?: InputMaybe<PriceOverrideInput[]>

Override the price of the subscription

`Optional`priceUnitAmount

priceUnitAmount?: InputMaybe<Scalars["Float"]>

`Optional`promotionCode

promotionCode?: InputMaybe<Scalars["String"]>

`Optional`refId

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

`Optional`resourceId

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

`Optional`salesforceId

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

`Optional`scheduleStrategy

scheduleStrategy?: InputMaybe<ScheduleStrategy>

`Optional`startDate

startDate?: InputMaybe<Scalars["DateTime"]>

`Optional`subscriptionEntitlements

subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>

`Optional`subscriptionId

subscriptionId?: InputMaybe<Scalars["String"]>

`Optional`trialEndBehavior

trialEndBehavior?: InputMaybe<TrialEndBehavior>

Indicates the behavior of the subscription when the trial is expired.

`Optional`unitQuantity

unitQuantity?: InputMaybe<Scalars["Float"]>