Type Alias ProvisionCustomerSubscriptionInput

Provision a new subscription for a customer

type ProvisionCustomerSubscriptionInput = {
    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>;
    charges?: InputMaybe<ChargeInput[]>;
    entitlements?: InputMaybe<SubscriptionEntitlementInputV2[]>;
    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"]>;
}

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`charges

charges?: InputMaybe<ChargeInput[]>

`Optional`entitlements

entitlements?: InputMaybe<SubscriptionEntitlementInputV2[]>

`Optional`minimumSpend

minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>

The minimum spend configuration

`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`startDate

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

`Optional`subscriptionEntitlements

subscriptionEntitlements?: InputMaybe<SubscriptionEntitlementInput[]>

`Optional`subscriptionId

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

`Optional`trialOverrideConfiguration

trialOverrideConfiguration?: InputMaybe<TrialOverrideConfigurationInput>

`Optional`unitQuantity

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