Choose a version:

Anchor to subscriptionContractCreateCalculate

subscriptionContractCreateCalculate

mutation

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

Starts an asynchronous calculation for a new subscription contract. The contract isn't created until you commit the calculation.

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 build a subscription contract.

Anchor to Arguments

Arguments

Anchor to contractCreateInputcontractCreateInput

•SubscriptionContractCalculationContractCreateInput!

required

The input for the new subscription contract calculation.

Was this section helpful?

Anchor to SubscriptionContractCreateCalculatePayload returnsSubscriptionContractCreateCalculatePayload returns

Anchor to subscriptionContractCalculationsubscriptionContractCalculation

•SubscriptionContractCalculation

The result of the subscription contract calculation operation.

Anchor to userErrorsuserErrors

•[SubscriptionContractCreateCalculateUserError!]!

non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

subscriptionContractCreateCalculate reference

Mutation Reference

mutation subscriptionContractCreateCalculate($contractCreateInput: SubscriptionContractCalculationContractCreateInput!) {

subscriptionContractCreateCalculate(contractCreateInput: $contractCreateInput) {

subscriptionContractCalculation {

# SubscriptionContractCalculation fields

}

userErrors {

field

message

}

Input

{

"contractCreateInput": {

"actor": "CUSTOMER",

"appManagedBillingConfig": {

"maxCycles": 1,

"minCycles": 1

"billingPolicy": {

"anchors": [

{}

"cadence": {}

"currencyCode": "AED",

"customAttributes": [

{

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

"value": "<your-value>"

}

"customerId": "gid://shopify/Customer/10079785100",

"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

{
  "contractCreateInput": {
    "actor": "CUSTOMER",
    "appManagedBillingConfig": {
      "maxCycles": 1,
      "minCycles": 1
    },
    "billingPolicy": {
      "anchors": [
        {}
      ],
      "cadence": {}
    },
    "currencyCode": "AED",
    "customAttributes": [
      {
        "key": "<your-key>",
        "value": "<your-value>"
      }
    ],
    "customerId": "gid://shopify/Customer/10079785100",
    "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 SubscriptionContractCalculationContractCreateInput {
  actor: SubscriptionActor
  appManagedBillingConfig: SubscriptionContractCalculationAppManagedBillingConfigInput
  billingPolicy: SubscriptionContractCalculationBillingPolicyInput!
  currencyCode: CurrencyCode!
  customAttributes: [AttributeInput!]!
  customerId: ID!
  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
}