younifyd
Menu

subscriptionBillingCycleSkip

Skips a Subscription Billing Cycle.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the subscriptionBillingCycleSkip action (under Subscription).
  3. Fill in the fields below, then reference the result from later steps as {{subscriptionbillingcycleskip.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 SubscriptionBillingCycleSkip($billingCycleInput: SubscriptionBillingCycleInput!) {
  subscriptionBillingCycleSkip(billingCycleInput: $billingCycleInput) {
    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
json
{
  "billingCycleInput": {
    "contractId": "string",
    "selector": {
      "index": 0,
      "date": "string"
    }
  }
}

Response

Read the result with {{subscriptionbillingcycleskip.response.data.data.subscriptionBillingCycleSkip}}. If the API returns errors, the step fails and they are at {{subscriptionbillingcycleskip.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.