Subscription
The input fields for calculating a new subscription contract. Provide the
complete desired state of the contract. The contract isn't created until you
commit the calculation with the mutation.
Learn how to build a subscription contract.
Anchor to FieldsFields
- actor (SubscriptionActor)
- appManagedBillingConfig (SubscriptionContractCalculationAppManagedBillingConfigInput)
- billingPolicy (SubscriptionContractCalculationBillingPolicyInput!)
- currencyCode (CurrencyCode!)
- customAttributes ([AttributeInput!]!)
- customerId (ID!)
- deliveryMethod (SubscriptionContractCalculationDeliveryMethodInput!)
- deliveryPolicy (SubscriptionContractCalculationDeliveryPolicyInput!)
- discountCodes ([SubscriptionContractCalculationDiscountCodeInput!]!)
- firstBillingDate (DateTime)
- lines ([SubscriptionContractCalculationLineInput!]!)
- manualDiscounts ([SubscriptionContractCalculationManualDiscountInput!]!)
- note (String)
- paymentMethod (SubscriptionContractCalculationPaymentMethodInput!)
- withMerchandiseCustomizations (Boolean!)
- Anchor to actoractor•Subscription
Actor The actor who initiated a subscription action.
- Anchor to appManagedBillingConfigapp•Subscription
Managed Billing Config Contract Calculation App Managed Billing Config Input App-managed billing configuration for the contract.
- Anchor to billingPolicybilling•Subscription
Policy Contract Calculation Billing Policy Input! required The billing policy for the new contract.
- Anchor to currencyCodecurrency•Currency
Code Code! non-null The currency code for the new subscription contract.
- Anchor to customAttributescustom•[Attribute
Attributes Input!]! requiredDefault:[] The custom attributes for the new contract.
- Anchor to customerIdcustomer•ID!
Id non-null The ID of the customer to associate with the new subscription contract.
- Anchor to deliveryMethoddelivery•Subscription
Method Contract Calculation Delivery Method Input! required The delivery method for the new contract. Provide
nonefor digital-only subscriptions. Provideinstead of a method to discover options for an address without committing a delivery method.- Anchor to deliveryPolicydelivery•Subscription
Policy Contract Calculation Delivery Policy Input! required The delivery policy for the new contract.
- Anchor to discountCodesdiscount•[Subscription
Codes Contract Calculation Discount Code Input!]! requiredDefault:[] The discount codes to apply during this calculation. Applied codes are resolved into manual discounts on the resulting contract. Defaults to an empty array (apply no discount codes).
- Anchor to firstBillingDatefirst•Date
Billing Date Time The date the contract first bills, overriding the end date of its first billing cycle. For example, a monthly contract created on May 14th bills first on June 14th by default; setting
to May 30th bills first on May 30th instead. This value also becomes the contract's next billing date. Later cycles follow the contract's billing policy anchors. It must be in the future.- Anchor to lineslines•[Subscription
Contract Calculation Line Input!]! required The subscription lines for the new contract.
- Anchor to manualDiscountsmanual•[Subscription
Discounts Contract Calculation Manual Discount Input!]! required The manual order and delivery discounts for the new contract. Provide an empty array for no manual discounts.
- Anchor to notenote•String
The note for the new contract.
- Anchor to paymentMethodpayment•Subscription
Method Contract Calculation Payment Method Input! required The payment method for the new contract. Provide
noneif no payment method is specified.- Anchor to withMerchandiseCustomizationswith•Boolean!
Merchandise Customizations non-null Specifies whether to use merchandise customizations in the calculation.