subscriptionContract

query

Code examples for QUERY: subscriptionContract

Query Reference for QUERY: subscriptionContract

"{\n  subscriptionContract(id) {\n    # SubscriptionContract fields\n  }\n}"

Input Reference for QUERY: subscriptionContract

Schema Reference for QUERY: subscriptionContract

Display Examples for QUERY: subscriptionContract

[
  {
    "example": {
      "type_name": "subscriptioncontract",
      "title": "Query for a subscription contract",
      "description": "Finds a subscription contract by id.",
      "query_string": "query findContract($subscriptionContractId: ID!) {\n  subscriptionContract(id: $subscriptionContractId) {\n    id\n    status\n    nextBillingDate\n  }\n}",
      "variables": {
        "subscriptionContractId": "gid://shopify/SubscriptionContract/593791907"
      },
      "response": {
        "data": {
          "subscriptionContract": {
            "id": "gid://shopify/SubscriptionContract/593791907",
            "status": "ACTIVE",
            "nextBillingDate": "2120-02-05T15:00:00Z"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/sales/subscriptions/test/unit/graph_api/admin/subscription_contract_test.rb",
      "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 findContract($subscriptionContractId: ID!) { subscriptionContract(id: $subscriptionContractId) { id status nextBillingDate } }\",\n \"variables\": {\n    \"subscriptionContractId\": \"gid://shopify/SubscriptionContract/593791907\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query findContract($subscriptionContractId: ID!) {\n    subscriptionContract(id: $subscriptionContractId) {\n      id\n      status\n      nextBillingDate\n    }\n  }`,\n  {\n    variables: {\n      \"subscriptionContractId\": \"gid://shopify/SubscriptionContract/593791907\"\n    },\n  },\n);\n\nconst data = await response.json();\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 findContract($subscriptionContractId: ID!) {\n    subscriptionContract(id: $subscriptionContractId) {\n      id\n      status\n      nextBillingDate\n    }\n  }\nQUERY\n\nvariables = {\n  \"subscriptionContractId\": \"gid://shopify/SubscriptionContract/593791907\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query findContract($subscriptionContractId: ID!) {\n      subscriptionContract(id: $subscriptionContractId) {\n        id\n        status\n        nextBillingDate\n      }\n    }`,\n    \"variables\": {\n      \"subscriptionContractId\": \"gid://shopify/SubscriptionContract/593791907\"\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query findContract($subscriptionContractId: ID!) {\n    subscriptionContract(id: $subscriptionContractId) {\n      id\n      status\n      nextBillingDate\n    }\n  }\nQUERY;\n\n$variables = [\n  \"subscriptionContractId\" => \"gid://shopify/SubscriptionContract/593791907\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  }
]