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

Anchor to SubscriptionBillingCycleSubscriptionBillingCycle • SubscriptionBillingCycle: A subscription billing cycle.

Was this section helpful?

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

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query subscriptionBillingCycle($contractId: ID!, $index: Int!) {
6    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
7      billingAttemptExpectedDate
8    }
9  }`,
10  {
11    variables: {
12      "contractId": "gid://shopify/SubscriptionContract/593791907",
13      "index": 1
14    },
15  },
16);
17
18const data = await response.json();
19

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/2025-01/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

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

Response

JSON

1{
2  "subscriptionBillingCycle": {
3    "billingAttemptExpectedDate": "2022-01-02T11:59:59Z"
4  }
5}