Choose a version:

Anchor to subscriptionBillingCycleContractEditCalculate

subscriptionBillingCycleContractEditCalculate

mutation

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

Starts an asynchronous calculation for changes to a single billing cycle of an existing subscription contract. Committing the calculation applies the changes only to the selected cycle, leaving the recurring contract unchanged.

Poll the subscriptionContractCalculation query to review the calculated contract, 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 billingCycleEditInputbillingCycleEditInput

•SubscriptionContractCalculationBillingCycleEditInput!

required

The input for the single billing cycle contract edit calculation.

Anchor to billingCycleSelectorbillingCycleSelector

•SubscriptionBillingCycleSelector!

required

Selects the billing cycle to edit, by index or date.

Anchor to contractIdcontractId

•ID!

required

The ID of the subscription contract to edit.

Was this section helpful?

Anchor to SubscriptionBillingCycleContractEditCalculatePayload returnsSubscriptionBillingCycleContractEditCalculatePayload returns

Anchor to subscriptionContractCalculationsubscriptionContractCalculation

•SubscriptionContractCalculation

The result of the subscription contract calculation operation.

Anchor to userErrorsuserErrors

•[SubscriptionBillingCycleContractEditCalculateUserError!]!

non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

subscriptionBillingCycleContractEditCalculate reference

Mutation Reference

mutation subscriptionBillingCycleContractEditCalculate($actor: SubscriptionActor, $billingCycleEditInput: SubscriptionContractCalculationBillingCycleEditInput!, $billingCycleSelector: SubscriptionBillingCycleSelector!, $contractId: ID!) {

subscriptionBillingCycleContractEditCalculate(actor: $actor, billingCycleEditInput: $billingCycleEditInput, billingCycleSelector: $billingCycleSelector, contractId: $contractId) {

subscriptionContractCalculation {

# SubscriptionContractCalculation fields

}

userErrors {

field

message

}

Input

{

"actor": "CUSTOMER",

"billingCycleEditInput": {

"customAttributes": [

{

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

"value": "<your-value>"

}

"deliveryMethod": {

"fetchAvailableDeliveryOptions": {},

"localDelivery": {},

"none": true,

"pickup": {},

"shipping": {}

"discountCodes": [

{

"redeemCode": "<your-redeemCode>"

}

"lines": [

{

"customLine": {},

"productVariantLine": {},

"productVariantParentLine": {}

}

"manualDiscounts": [

{

"deliveryDiscount": {},

"orderDiscount": {}

}

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

"withMerchandiseCustomizations": true

"billingCycleSelector": {

"date": "2019-09-07T15:50:00Z",

"index": 1

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

}

Variables

{
  "actor": "CUSTOMER",
  "billingCycleEditInput": {
    "customAttributes": [
      {
        "key": "<your-key>",
        "value": "<your-value>"
      }
    ],
    "deliveryMethod": {
      "fetchAvailableDeliveryOptions": {},
      "localDelivery": {},
      "none": true,
      "pickup": {},
      "shipping": {}
    },
    "discountCodes": [
      {
        "redeemCode": "<your-redeemCode>"
      }
    ],
    "lines": [
      {
        "customLine": {},
        "productVariantLine": {},
        "productVariantParentLine": {}
      }
    ],
    "manualDiscounts": [
      {
        "deliveryDiscount": {},
        "orderDiscount": {}
      }
    ],
    "note": "<your-note>",
    "withMerchandiseCustomizations": true
  },
  "billingCycleSelector": {
    "date": "2019-09-07T15:50:00Z",
    "index": 1
  },
  "contractId": "gid://shopify/SubscriptionContract/10079785100"
}

Schema

input SubscriptionContractCalculationBillingCycleEditInput {
  customAttributes: [AttributeInput!]
  deliveryMethod: SubscriptionContractCalculationDeliveryMethodInput
  discountCodes: [SubscriptionContractCalculationDiscountCodeInput!]!
  lines: [SubscriptionContractCalculationLineInput!]
  manualDiscounts: [SubscriptionContractCalculationManualDiscountInput!]
  note: String
  withMerchandiseCustomizations: Boolean!
}

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

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

input SubscriptionContractCalculationDiscountCodeInput {
  redeemCode: String!
}

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

input SubscriptionContractCalculationManualDiscountInput {
  deliveryDiscount: SubscriptionContractCalculationDeliveryDiscountInput
  orderDiscount: SubscriptionContractCalculationOrderDiscountInput
}

input SubscriptionBillingCycleSelector {
  date: DateTime
  index: Int
}