subscriptionContract

query

Returns a Subscription Contract resource by ID.

Arguments

Anchor to idid • ID!required: The ID of the Subscription Contract to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to SubscriptionContractSubscriptionContract • SubscriptionContract: Represents a Subscription Contract.

Was this section helpful?

Query for a subscription contract

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

const response = await admin.graphql(

`#graphql

query findContract($subscriptionContractId: ID!) {

subscriptionContract(id: $subscriptionContractId) {

status

nextBillingDate

}

}`,

{

variables: {

"subscriptionContractId": "gid://shopify/SubscriptionContract/593791907"

);

const data = await response.json();

query findContract($subscriptionContractId: ID!) {
  subscriptionContract(id: $subscriptionContractId) {
    id
    status
    nextBillingDate
  }
}

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 findContract($subscriptionContractId: ID!) { subscriptionContract(id: $subscriptionContractId) { id status nextBillingDate } }",
 "variables": {
    "subscriptionContractId": "gid://shopify/SubscriptionContract/593791907"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query findContract($subscriptionContractId: ID!) {
    subscriptionContract(id: $subscriptionContractId) {
      id
      status
      nextBillingDate
    }
  }`,
  {
    variables: {
      "subscriptionContractId": "gid://shopify/SubscriptionContract/593791907"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query findContract($subscriptionContractId: ID!) {
      subscriptionContract(id: $subscriptionContractId) {
        id
        status
        nextBillingDate
      }
    }`,
    "variables": {
      "subscriptionContractId": "gid://shopify/SubscriptionContract/593791907"
    },
  },
});

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 findContract($subscriptionContractId: ID!) {
    subscriptionContract(id: $subscriptionContractId) {
      id
      status
      nextBillingDate
    }
  }
QUERY

variables = {
  "subscriptionContractId": "gid://shopify/SubscriptionContract/593791907"
}

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

Input variables

JSON

{

"subscriptionContractId": "gid://shopify/SubscriptionContract/593791907"

}

Response

JSON

{

"subscriptionContract": {

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

"status": "ACTIVE",

"nextBillingDate": "2120-02-05T15:00:00Z"

}