appSubscriptionTrialExtend - admin-graphql - MUTATION

Version: 2024-10

Description:

Extends the trial of an app subscription.

Access Scopes

This must be a third party developed application that you can access.

Arguments

• days: Int! - The number of days to extend the trial. The value must be greater than 0 and less than or equal to 1000.
• id: ID! - The ID of the app subscription to extend the trial for.

Returns

• appSubscription: AppSubscription The app subscription that had its trial extended.
• userErrors: AppSubscriptionTrialExtendUserError! The list of errors that occurred from executing the mutation.

Examples

• Extend an app subscription for a shop

          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\": \"mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) { appSubscriptionTrialExtend(id: $id, days: $days) { userErrors { field message code } appSubscription { id status } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/AppSubscription/443388186\",\n    \"days\": 10\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {\n      appSubscriptionTrialExtend(id: $id, days: $days) {\n        userErrors {\n          field\n          message\n          code\n        }\n        appSubscription {\n          id\n          status\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/AppSubscription/443388186\",\n      \"days\": 10\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  mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {\n    appSubscriptionTrialExtend(id: $id, days: $days) {\n      userErrors {\n        field\n        message\n        code\n      }\n      appSubscription {\n        id\n        status\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/AppSubscription/443388186\",\n  \"days\": 10\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  mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {\n    appSubscriptionTrialExtend(id: $id, days: $days) {\n      userErrors {\n        field\n        message\n        code\n      }\n      appSubscription {\n        id\n        status\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/AppSubscription/443388186\",\n  \"days\" => 10,\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  mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {\n    appSubscriptionTrialExtend(id: $id, days: $days) {\n      userErrors {\n        field\n        message\n        code\n      }\n      appSubscription {\n        id\n        status\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/AppSubscription/443388186\",\n      \"days\": 10\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {\n  appSubscriptionTrialExtend(id: $id, days: $days) {\n    userErrors {\n      field\n      message\n      code\n    }\n    appSubscription {\n      id\n      status\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/AppSubscription/443388186",
    "days": 10
  }

  response: {
    "data": {
      "appSubscriptionTrialExtend": {
        "userErrors": [],
        "appSubscription": {
          "id": "gid://shopify/AppSubscription/443388186",
          "status": "ACTIVE"
        }
      }
    }
  }