subscriptionBillingCycle - admin-graphql - QUERY

Version: 2024-10

Description:

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

Access Scopes

Arguments

• billingCycleInput: SubscriptionBillingCycleInput! - Input object used to select and use billing cycles.

Returns

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

Examples

• Get a billing cycle by cycle index

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query subscriptionBillingCycle($contractId: ID!, $index: Int!) { subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) { billingAttemptExpectedDate } }\",\n \"variables\": {\n    \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n    \"index\": 1\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n      subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n        billingAttemptExpectedDate\n      }\n    }`,\n    \"variables\": {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n      \"index\": 1\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n      billingAttemptExpectedDate\n    }\n  }\nQUERY\n\nvariables = {\n  \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n  \"index\": 1\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n      billingAttemptExpectedDate\n    }\n  }\nQUERY;\n\n$variables = [\n  \"contractId\" => \"gid://shopify/SubscriptionContract/593791907\",\n  \"index\" => 1,\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n      billingAttemptExpectedDate\n    }\n  }`,\n  {\n    variables: {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n      \"index\": 1\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n  subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n    billingAttemptExpectedDate\n  }\n}"
        

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

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

  Get a billing cycle by date

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) { subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) { billingAttemptExpectedDate } }\",\n \"variables\": {\n    \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n    \"date\": \"2022-12-01T00:00:00Z\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n      subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n        billingAttemptExpectedDate\n      }\n    }`,\n    \"variables\": {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n      \"date\": \"2022-12-01T00:00:00Z\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n      billingAttemptExpectedDate\n    }\n  }\nQUERY\n\nvariables = {\n  \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n  \"date\": \"2022-12-01T00:00:00Z\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n      billingAttemptExpectedDate\n    }\n  }\nQUERY;\n\n$variables = [\n  \"contractId\" => \"gid://shopify/SubscriptionContract/593791907\",\n  \"date\" => \"2022-12-01T00:00:00Z\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n    subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n      billingAttemptExpectedDate\n    }\n  }`,\n  {\n    variables: {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n      \"date\": \"2022-12-01T00:00:00Z\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n  subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n    billingAttemptExpectedDate\n  }\n}"
        

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

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