Subscription
The input fields for delivery used during a contract calculation. This is a oneOf input: one, and only one, field can be provided.
Provide shipping, , or pickup to set the committed delivery method.
Provide none to explicitly set no delivery method (digital-only subscriptions).
Provide to discover the available delivery options for an
address without changing the contract's committed delivery method.
Anchor to FieldsFields
- fetchAvailableDeliveryOptions (SubscriptionContractCalculationFetchDeliveryOptionsInput)
- localDelivery (SubscriptionContractCalculationDeliveryMethodLocalDeliveryInput)
- none (Boolean)
- pickup (SubscriptionContractCalculationDeliveryMethodPickupInput)
- shipping (SubscriptionContractCalculationDeliveryMethodShippingInput)
- Anchor to fetchAvailableDeliveryOptionsfetch•Subscription
Available Delivery Options Contract Calculation Fetch Delivery Options Input Discover the available delivery options for an address without changing the contract's committed delivery method. Mutually exclusive with setting a delivery method.
- Anchor to localDeliverylocal•Subscription
Delivery Contract Calculation Delivery Method Local Delivery Input The input fields for the local delivery method.
- Anchor to nonenone•Boolean
Explicitly set no delivery method (digital-only subscriptions). Must be
true.- Anchor to pickuppickup•Subscription
Contract Calculation Delivery Method Pickup Input The input fields for the pickup delivery method.
- Anchor to shippingshipping•Subscription
Contract Calculation Delivery Method Shipping Input The input fields for the shipping delivery method.
Anchor to Input objects using this inputInput objects using this input
- Anchor to SubscriptionContractCalculationBillingCycleEditInput.deliveryMethodSubscription•INPUT OBJECT
Contract Calculation Billing Cycle Edit Input.deliveryMethod 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 SubscriptionContractCalculationContractCreateInput.deliveryMethodSubscription•INPUT OBJECT
Contract Calculation Contract Create Input.deliveryMethod 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 SubscriptionContractCalculationContractUpdateInput.deliveryMethodSubscription•INPUT OBJECT
Contract Calculation Contract Update Input.deliveryMethod 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
idof each existing item that you want to keep.Learn how to update a subscription contract.