Choose a version:

subscriptionBillingCycle

query

Returns a subscription billing cycle found either by cycle index or date.

Arguments

Anchor to billingCycleInputbillingCycleInput • SubscriptionBillingCycleInput!required: Input object used to select and use billing cycles.

Was this section helpful?

Anchor to Possible returnsPossible returns

SubscriptionBillingCycle

•

SubscriptionBillingCycle

A subscription billing cycle.

billingAttemptExpectedDate• DateTime! non-null: The date on which the billing attempt is expected to be made.
billingAttempts • SubscriptionBillingAttemptConnection! non-null: The list of billing attempts associated with the billing cycle.
cycleEndAt• DateTime! non-null: The end date of the billing cycle.
cycleIndex• Int! non-null: The index of the billing cycle.
cycleStartAt• DateTime! non-null: The start date of the billing cycle.
edited• Boolean! non-null: Whether this billing cycle was edited.
editedContract• SubscriptionBillingCycleEditedContract: The active edited contract for the billing cycle.
skipped• Boolean! non-null: Whether this billing cycle was skipped.
sourceContract• SubscriptionContract! non-null: The subscription contract that the billing cycle belongs to.
status• SubscriptionBillingCycleBillingCycleStatus! non-null: The status of the billing cycle.

Was this section helpful?

Get a billing cycle by cycle index
Get a billing cycle by date

Examples

Open in GraphiQL

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 data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/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
  }
}'

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 data = await response.json();

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
    },
  },
});

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"

}