Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to cycleEndAtcycleEndAt

•DateTime!

non-null

The end date of the billing cycle.

Anchor to cycleIndexcycleIndex

•Int!

non-null

The index of the billing cycle.

Anchor to cycleStartAtcycleStartAt

•DateTime!

non-null

The start date of the billing cycle.

Anchor to editededited

•Boolean!

non-null

Whether this billing cycle was edited.

Anchor to editedContracteditedContract

•SubscriptionBillingCycleEditedContract

The active edited contract for the billing cycle.

Anchor to skippedskipped

•Boolean!

non-null

Whether this billing cycle was skipped.

Anchor to sourceContractsourceContract

•SubscriptionContract!

non-null

The subscription contract that the billing cycle belongs to.

Anchor to statusstatus

•SubscriptionBillingCycleBillingCycleStatus!

non-null

The status of the billing cycle.

Was this section helpful?

Examples

Get a billing cycle by cycle index

Description

Retrieves a billing cycle with cycle index `1` and returns the `billingAttemptExpectedDate`.

Query

query subscriptionBillingCycle($contractId: ID!, $index: Int!) {
  subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
    billingAttemptExpectedDate
  }
}

Variables

{
  "contractId": "gid://shopify/SubscriptionContract/593791907",
  "index": 1
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query subscriptionBillingCycle($contractId: ID!, $index: Int!) { subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) { billingAttemptExpectedDate } }",
 "variables": {
    "contractId": "gid://shopify/SubscriptionContract/593791907",
    "index": 1
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query subscriptionBillingCycle($contractId: ID!, $index: Int!) {
    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
      billingAttemptExpectedDate
    }
  }`,
  {
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/593791907",
        "index": 1
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query subscriptionBillingCycle($contractId: ID!, $index: Int!) {
    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
      billingAttemptExpectedDate
    }
  }
QUERY

variables = {
  "contractId": "gid://shopify/SubscriptionContract/593791907",
  "index": 1
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query subscriptionBillingCycle($contractId: ID!, $index: Int!) {
      subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
        billingAttemptExpectedDate
      }
    }`,
    "variables": {
        "contractId": "gid://shopify/SubscriptionContract/593791907",
        "index": 1
    },
  },
});

Response

{
  "subscriptionBillingCycle": {
    "billingAttemptExpectedDate": "2022-01-02T11:59:59Z"
  }
}

Get a billing cycle by date

Description

Retrieves the billing cycle that includes the date `2022-12-01` and returns the `billingAttemptExpectedDate`.

Query

query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {
  subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {
    billingAttemptExpectedDate
  }
}

Variables

{
  "contractId": "gid://shopify/SubscriptionContract/593791907",
  "date": "2022-12-01T00:00:00Z"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) { subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) { billingAttemptExpectedDate } }",
 "variables": {
    "contractId": "gid://shopify/SubscriptionContract/593791907",
    "date": "2022-12-01T00:00:00Z"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {
    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {
      billingAttemptExpectedDate
    }
  }`,
  {
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/593791907",
        "date": "2022-12-01T00:00:00Z"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {
    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {
      billingAttemptExpectedDate
    }
  }
QUERY

variables = {
  "contractId": "gid://shopify/SubscriptionContract/593791907",
  "date": "2022-12-01T00:00:00Z"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {
      subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {
        billingAttemptExpectedDate
      }
    }`,
    "variables": {
        "contractId": "gid://shopify/SubscriptionContract/593791907",
        "date": "2022-12-01T00:00:00Z"
    },
  },
});

Response

{
  "subscriptionBillingCycle": {
    "billingAttemptExpectedDate": "2022-12-02T01:00:00Z"
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query subscriptionBillingCycle($contractId: ID!, $index: Int!) {

subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {

billingAttemptExpectedDate

}

}`,

{

variables: {

"contractId": "gid://shopify/SubscriptionContract/593791907",

"index": 1

);

const json = await response.json();

return json.data;

}

GQL

query subscriptionBillingCycle($contractId: ID!, $index: Int!) {
  subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
    billingAttemptExpectedDate
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query subscriptionBillingCycle($contractId: ID!, $index: Int!) { subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) { billingAttemptExpectedDate } }",
 "variables": {
    "contractId": "gid://shopify/SubscriptionContract/593791907",
    "index": 1
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query subscriptionBillingCycle($contractId: ID!, $index: Int!) {
    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
      billingAttemptExpectedDate
    }
  }`,
  {
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/593791907",
        "index": 1
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query subscriptionBillingCycle($contractId: ID!, $index: Int!) {
      subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
        billingAttemptExpectedDate
      }
    }`,
    "variables": {
        "contractId": "gid://shopify/SubscriptionContract/593791907",
        "index": 1
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query subscriptionBillingCycle($contractId: ID!, $index: Int!) {
    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
      billingAttemptExpectedDate
    }
  }
QUERY

variables = {
  "contractId": "gid://shopify/SubscriptionContract/593791907",
  "index": 1
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"contractId": "gid://shopify/SubscriptionContract/593791907",

"index": 1

}

Response

JSON

{

"subscriptionBillingCycle": {

"billingAttemptExpectedDate": "2022-01-02T11:59:59Z"

}