SubscriptionContract - admin-graphql - OBJECT

Version: 2024-10

Description:

Represents a Subscription Contract.

Access Scopes

the `read_own_subscription_contracts` or `write_own_subscription_contracts` scope.

Fields

• app: App - The subscription app that the subscription contract is registered to.
• appAdminUrl: URL - The URL of the subscription contract page on the subscription app.
• billingPolicy: SubscriptionBillingPolicy! - The billing policy associated with the subscription contract.
• createdAt: DateTime! - The date and time when the subscription contract was created.
• currencyCode: CurrencyCode! - The currency that's used for the subscription contract.
• customAttributes: Attribute! - A list of the custom attributes to be added to the generated orders.
• customer: Customer - The customer to whom the subscription contract belongs.
• customerPaymentMethod: CustomerPaymentMethod - The customer payment method that's used for the subscription contract.
• deliveryMethod: SubscriptionDeliveryMethod - The delivery method for each billing of the subscription contract.
• deliveryPolicy: SubscriptionDeliveryPolicy! - The delivery policy associated with the subscription contract.
• deliveryPrice: MoneyV2! - The delivery price for each billing of the subscription contract.
• id: ID! - A globally-unique ID.
• lastBillingAttemptErrorType: SubscriptionContractLastBillingErrorType - The last billing error type of the contract.
• lastPaymentStatus: SubscriptionContractLastPaymentStatus - The current status of the last payment.
• lineCount: Int! - The number of lines associated with the subscription contract.
• linesCount: Count - The number of lines associated with the subscription contract.
• nextBillingDate: DateTime - The next billing date for the subscription contract. This field is managed by the apps. Alternatively you can utilize our [Billing Cycles APIs](https://shopify.dev/docs/apps/selling-strategies/subscriptions/billing-cycles), which provide auto-computed billing dates and additional functionalities.
• note: String - The note field that will be applied to the generated orders.
• originOrder: Order - The order from which this contract originated.
• revisionId: UnsignedInt64! - The revision id of the contract.
• status: SubscriptionContractSubscriptionStatus! - The current status of the subscription contract.
• updatedAt: DateTime! - The date and time when the subscription contract was updated.

Connections

• billingAttempts: SubscriptionBillingAttemptConnection!
• discounts: SubscriptionManualDiscountConnection!
• lines: SubscriptionLineConnection!
• orders: OrderConnection!

Related queries

• subscriptionContract Returns a Subscription Contract resource by ID.
• subscriptionContracts List Subscription Contracts.

Related mutations

• subscriptionContractActivate Activates a Subscription Contract.
• subscriptionContractAtomicCreate Creates a Subscription Contract.
• subscriptionContractCancel Cancels a Subscription Contract.
• subscriptionContractExpire Expires a Subscription Contract.
• subscriptionContractFail Fails a Subscription Contract.
• subscriptionContractPause Pauses a Subscription Contract.
• subscriptionContractProductChange Allows for the easy change of a Product in a Contract or a Product price change.
• subscriptionContractSetNextBillingDate Sets the next billing date of a Subscription Contract. This field is managed by the apps. Alternatively you can utilize our [Billing Cycles APIs](https://shopify.dev/docs/apps/selling-strategies/subscriptions/billing-cycles), which provide auto-computed billing dates and additional functionalities.
• subscriptionDraftCommit Commits the updates of a Subscription Contract draft.

Related Unions

Examples

• Query for a subscription contract

          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"
          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"
          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"
          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"
          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"
          Graphql query: "query findContract($subscriptionContractId: ID!) {\n  subscriptionContract(id: $subscriptionContractId) {\n    id\n    status\n    nextBillingDate\n  }\n}"
        

  input: {
    "subscriptionContractId": "gid://shopify/SubscriptionContract/593791907"
  }

  response: {
    "data": {
      "subscriptionContract": {
        "id": "gid://shopify/SubscriptionContract/593791907",
        "status": "ACTIVE",
        "nextBillingDate": "2120-02-05T15:00:00Z"
      }
    }
  }