Subscription
The input fields for editing a subscription contract for a single billing cycle, used for contract calculation. Any field provided will update or replace the corresponding value for the targeted cycle. Fields that are omitted will be left unchanged. Contract-level attributes such as billing policy, delivery policy, and payment method cannot be changed by a billing cycle edit.
Anchor to FieldsFields
- customAttributes ([AttributeInput!])
- deliveryMethod (SubscriptionContractCalculationDeliveryMethodInput)
- discountCodes ([SubscriptionContractCalculationDiscountCodeInput!]!)
- lines ([SubscriptionContractCalculationLineInput!])
- manualDiscounts ([SubscriptionContractCalculationManualDiscountInput!])
- note (String)
- withMerchandiseCustomizations (Boolean!)
- Anchor to customAttributescustom•[Attribute
Attributes Input!] The custom attributes for the targeted billing cycle. 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 targeted billing cycle. 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 discountCodesdiscount•[Subscription
Codes Contract Calculation Discount Code Input!]! requiredDefault:[] The discount codes to apply to the targeted billing cycle during this calculation. Applied codes are resolved into manual discounts; discount codes aren't persisted as codes, so there is 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 for the targeted billing cycle. 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 for the targeted billing cycle. 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 targeted billing cycle. To remove the existing note, pass
null.- Anchor to withMerchandiseCustomizationswith•Boolean!
Merchandise Customizations non-null Specifies whether to use merchandise customizations in the calculation.