Subscription
The input fields for calculating changes to an existing subscription contract.
Each field you provide replaces the corresponding value on the contract, and
omitted fields remain unchanged. For list fields, provide the complete
replacement list, including the id of each existing item that you want to keep.
Learn how to update a subscription contract.
Anchor to FieldsFields
- appManagedBillingConfig (SubscriptionContractCalculationAppManagedBillingConfigInput)
- billingPolicy (SubscriptionContractCalculationBillingPolicyInput)
- customAttributes ([AttributeInput!])
- deliveryMethod (SubscriptionContractCalculationDeliveryMethodInput)
- deliveryPolicy (SubscriptionContractCalculationDeliveryPolicyInput)
- discountCodes ([SubscriptionContractCalculationDiscountCodeInput!]!)
- lines ([SubscriptionContractCalculationLineInput!])
- manualDiscounts ([SubscriptionContractCalculationManualDiscountInput!])
- note (String)
- paymentMethod (SubscriptionContractCalculationPaymentMethodInput)
- withMerchandiseCustomizations (Boolean!)
- Anchor to appManagedBillingConfigapp•Subscription
Managed Billing Config Contract Calculation App Managed Billing Config Input App-managed billing configuration for the contract. Replaces the existing configuration.
- Anchor to billingPolicybilling•Subscription
Policy Contract Calculation Billing Policy Input The billing policy for the contract. Replaces the existing billing policy.
- Anchor to customAttributescustom•[Attribute
Attributes Input!] The custom attributes for the contract. Replaces all existing attributes. To remove all attributes, provide an empty array (
[]).- Anchor to deliveryMethoddelivery•Subscription
Method Contract Calculation Delivery Method Input The delivery method for the contract. Replaces the existing delivery method. Provide
noneto remove the delivery method. Provideinstead of a method to discover options for an address without changing the committed delivery method.- Anchor to deliveryPolicydelivery•Subscription
Policy Contract Calculation Delivery Policy Input The delivery policy for the contract. Replaces the existing delivery policy.
- 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 contract; discount codes aren't persisted as codes, so there's nothing to preserve or replace across calculations. Defaults to an empty array (apply no discount codes).
- Anchor to lineslines•[Subscription
Contract Calculation Line Input!] The subscription lines to set on the contract. Replaces all existing lines with the contents of this array. At least one line is required.
- To update an existing line within the new set, include its
id. - To add a new line, omit its
id.
- To update an existing line within the new set, include its
- Anchor to manualDiscountsmanual•[Subscription
Discounts Contract Calculation Manual Discount Input!] The manual order and delivery discounts to set on the contract. Replaces all existing manual discounts.
- To update an existing discount within the new set, include its
id. - To add a new discount, omit its
id. - To remove all manual discounts, provide an empty array (
[]).
- To update an existing discount within the new set, include its
- Anchor to notenote•String
The note for the contract. To remove the existing note, pass
null.- Anchor to paymentMethodpayment•Subscription
Method Contract Calculation Payment Method Input The payment method for the contract. Replaces the existing payment method. Provide
noneto remove the payment method.- Anchor to withMerchandiseCustomizationswith•Boolean!
Merchandise Customizations non-null Specifies whether to use merchandise customizations in the calculation.