subscriptionBillingCycleScheduleEdit

Modify the schedule of a specific billing cycle.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the subscriptionBillingCycleScheduleEdit action (under Subscription).
Fill in the fields below, then reference the result from later steps as {{subscriptionbillingcyclescheduleedit.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 SubscriptionBillingCycleScheduleEdit($billingCycleInput: SubscriptionBillingCycleInput!, $input: SubscriptionBillingCycleScheduleEditInput!) {
  subscriptionBillingCycleScheduleEdit(
    billingCycleInput: $billingCycleInput
    input: $input
  ) {
    billingCycle {
      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.

billingCycleInputobjectrequired

Input object for selecting and using billing cycles.

contractIdstringrequired

selectorobjectrequired2 fields

inputobjectrequired

Data used to create or modify billing cycle schedule edit.

skipboolean

billingDatestring

reasonstringrequired

One ofBUYER_INITIATEDMERCHANT_INITIATEDDEV_INITIATED

json

{
  "billingCycleInput": {
    "contractId": "string",
    "selector": {
      "index": 0,
      "date": "string"
    }
  },
  "input": {
    "reason": "BUYER_INITIATED",
    "skip": false,
    "billingDate": "string"
  }
}

Response

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

billingCycleobject

billingAttemptExpectedDatestring

cycleEndAtstring

cycleIndexnumber

cycleStartAtstring

editedboolean

editedContractobject12 fields

skippedboolean

sourceContractobject21 fields

statusstring

One ofBILLEDUNBILLED

userErrorsarray<object>

codeobject

fieldobject

messageobject

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

Was this page helpful?