Choose a version:

Anchor to subscriptionContractUpdateCalculate

subscriptionContractUpdateCalculate

mutation

Requires write_own_subscription_contracts access scope. Also: The user must have manage_orders_information permission.

Starts an asynchronous calculation for changes to an existing subscription contract. The changes aren't applied to the contract until you commit the calculation, and fields omitted from the input remain unchanged.

Poll the subscriptionContractCalculation query to review the calculated contract, its projected order totals, and any warnings, then commit it with the subscriptionContractCalculationCommit mutation.

Learn how to update a subscription contract.

Anchor to Arguments

Arguments

Anchor to actoractor

•SubscriptionActor

The actor who initiated a subscription action.

Anchor to contractIdcontractId

•ID!

required

The ID of the subscription contract to update.

Anchor to contractUpdateInputcontractUpdateInput

•SubscriptionContractCalculationContractUpdateInput!

required

The input for the subscription contract update calculation.

Was this section helpful?

Anchor to SubscriptionContractUpdateCalculatePayload returnsSubscriptionContractUpdateCalculatePayload returns

Anchor to subscriptionContractCalculationsubscriptionContractCalculation

•SubscriptionContractCalculation

The result of the subscription contract calculation operation.

Anchor to userErrorsuserErrors

•[SubscriptionContractUpdateCalculateUserError!]!

non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

subscriptionContractUpdateCalculate reference

Mutation Reference

mutation subscriptionContractUpdateCalculate($actor: SubscriptionActor, $contractId: ID!, $contractUpdateInput: SubscriptionContractCalculationContractUpdateInput!) {

subscriptionContractUpdateCalculate(actor: $actor, contractId: $contractId, contractUpdateInput: $contractUpdateInput) {

subscriptionContractCalculation {

# SubscriptionContractCalculation fields

}

userErrors {

field

message

}

Input

{

"actor": "CUSTOMER",

"contractId": "gid://shopify/SubscriptionContract/10079785100",

"contractUpdateInput": {

"appManagedBillingConfig": {

"maxCycles": 1,

"minCycles": 1

"billingPolicy": {

"anchors": [

{}

"cadence": {}

"customAttributes": [

{

"key": "<your-key>",

"value": "<your-value>"

}

"deliveryMethod": {

"fetchAvailableDeliveryOptions": {},

"localDelivery": {},

"none": true,

"pickup": {},

"shipping": {}

"deliveryPolicy": {

"anchors": [

{}

"multiFulfillment": {}

"discountCodes": [

{

"redeemCode": "<your-redeemCode>"

}

"lines": [

{

"customLine": {},

"productVariantLine": {},

"productVariantParentLine": {}

}

"manualDiscounts": [

{

"deliveryDiscount": {},

"orderDiscount": {}

}

"note": "<your-note>",

"paymentMethod": {

"customerPaymentMethod": {},

"none": true

"withMerchandiseCustomizations": true

}

Variables

{
  "actor": "CUSTOMER",
  "contractId": "gid://shopify/SubscriptionContract/10079785100",
  "contractUpdateInput": {
    "appManagedBillingConfig": {
      "maxCycles": 1,
      "minCycles": 1
    },
    "billingPolicy": {
      "anchors": [
        {}
      ],
      "cadence": {}
    },
    "customAttributes": [
      {
        "key": "<your-key>",
        "value": "<your-value>"
      }
    ],
    "deliveryMethod": {
      "fetchAvailableDeliveryOptions": {},
      "localDelivery": {},
      "none": true,
      "pickup": {},
      "shipping": {}
    },
    "deliveryPolicy": {
      "anchors": [
        {}
      ],
      "multiFulfillment": {}
    },
    "discountCodes": [
      {
        "redeemCode": "<your-redeemCode>"
      }
    ],
    "lines": [
      {
        "customLine": {},
        "productVariantLine": {},
        "productVariantParentLine": {}
      }
    ],
    "manualDiscounts": [
      {
        "deliveryDiscount": {},
        "orderDiscount": {}
      }
    ],
    "note": "<your-note>",
    "paymentMethod": {
      "customerPaymentMethod": {},
      "none": true
    },
    "withMerchandiseCustomizations": true
  }
}

Schema

input SubscriptionContractCalculationContractUpdateInput {
  appManagedBillingConfig: SubscriptionContractCalculationAppManagedBillingConfigInput
  billingPolicy: SubscriptionContractCalculationBillingPolicyInput
  customAttributes: [AttributeInput!]
  deliveryMethod: SubscriptionContractCalculationDeliveryMethodInput
  deliveryPolicy: SubscriptionContractCalculationDeliveryPolicyInput
  discountCodes: [SubscriptionContractCalculationDiscountCodeInput!]!
  lines: [SubscriptionContractCalculationLineInput!]
  manualDiscounts: [SubscriptionContractCalculationManualDiscountInput!]
  note: String
  paymentMethod: SubscriptionContractCalculationPaymentMethodInput
  withMerchandiseCustomizations: Boolean!
}

input SubscriptionContractCalculationAppManagedBillingConfigInput {
  maxCycles: Int
  minCycles: Int
}

input SubscriptionContractCalculationBillingPolicyInput {
  anchors: [SubscriptionContractCalculationAnchorInput!]!
  cadence: SubscriptionContractCalculationCadenceInput!
}

input AttributeInput {
  key: String!
  value: String!
}

input SubscriptionContractCalculationDeliveryMethodInput {
  fetchAvailableDeliveryOptions: SubscriptionContractCalculationFetchDeliveryOptionsInput
  localDelivery: SubscriptionContractCalculationDeliveryMethodLocalDeliveryInput
  none: Boolean
  pickup: SubscriptionContractCalculationDeliveryMethodPickupInput
  shipping: SubscriptionContractCalculationDeliveryMethodShippingInput
}

input SubscriptionContractCalculationDeliveryPolicyInput {
  anchors: [SubscriptionContractCalculationAnchorInput!]!
  multiFulfillment: SubscriptionContractCalculationMultipleFulfillmentConfigInput
}

input SubscriptionContractCalculationDiscountCodeInput {
  redeemCode: String!
}

input SubscriptionContractCalculationLineInput {
  customLine: SubscriptionContractCalculationCustomLineInput
  productVariantLine: SubscriptionContractCalculationProductVariantLineInput
  productVariantParentLine: SubscriptionContractCalculationProductVariantParentLineInput
}

input SubscriptionContractCalculationManualDiscountInput {
  deliveryDiscount: SubscriptionContractCalculationDeliveryDiscountInput
  orderDiscount: SubscriptionContractCalculationOrderDiscountInput
}

input SubscriptionContractCalculationPaymentMethodInput {
  customerPaymentMethod: SubscriptionContractCalculationCustomerPaymentMethodInput
  none: Boolean
}