subscriptionBillingCycleEditsDelete

Delete the current and future schedule and contract edits of a list of subscription billing cycles.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the subscriptionBillingCycleEditsDelete action (under Subscription).
Fill in the fields below, then reference the result from later steps as {{subscriptionbillingcycleeditsdelete.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation SubscriptionBillingCycleEditsDelete($contractId: ID!, $targetSelection: SubscriptionBillingCyclesTargetSelection!) {
  subscriptionBillingCycleEditsDelete(
    contractId: $contractId
    targetSelection: $targetSelection
  ) {
    billingCycles {
      billingAttemptExpectedDate
      cycleEndAt
      cycleIndex
      cycleStartAt
      edited
      editedContract {
        app
        appAdminUrl
        createdAt
        currencyCode
        customAttributes
        customer
        deliveryMethod
        deliveryPrice
        lineCount
        linesCount
        note
        updatedAt
      }
      skipped
      sourceContract {
        app
        appAdminUrl
        billingPolicy
        createdAt
        currencyCode
        customAttributes
        customer
        deliveryMethod
        deliveryPolicy
        deliveryPrice
        id
        lastBillingAttemptErrorType
        lastPaymentStatus
        lineCount
        linesCount
        nextBillingDate
        note
        originOrder
        revisionId
        status
        updatedAt
      }
      status
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

contractIdstringrequired

The globally-unique identifier of the subscription contract that the billing cycle belongs to.

targetSelectionstringrequired

Select billing cycles to be deleted.

One ofALL

json

{
  "contractId": "string",
  "targetSelection": "ALL"
}

Response

Read the result with {{subscriptionbillingcycleeditsdelete.response.data.data.subscriptionBillingCycleEditsDelete}}. If the API returns errors, the step fails and they are at {{subscriptionbillingcycleeditsdelete.response.data.errors}}.

billingCyclesarray<object>

billingAttemptExpectedDateobject

cycleEndAtobject

cycleIndexobject

cycleStartAtobject

editedobject

editedContractobject

skippedobject

sourceContractobject

statusobject

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?