Anchor to section titled 'undefined'app
app
mutation
2024-07
Requires This must be a third party developed application that you can access.
Extends the trial of an app subscription.
Anchor to section titled 'Arguments'
Arguments
The number of days to extend the trial. The value must be greater than 0 and less than or equal to 1000.
The ID of the app subscription to extend the trial for.
Was this section helpful?
Anchor to section titled 'AppSubscriptionTrialExtendPayload returns'
AppSubscriptionTrialExtendPayload returns
The app subscription that had its trial extended.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: appSubscriptionTrialExtend
Query Reference for MUTATION: appSubscriptionTrialExtend
"mutation appSubscriptionTrialExtend($days: Int!, $id: ID!) {\n appSubscriptionTrialExtend(days: $days, id: $id) {\n appSubscription {\n # AppSubscription fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: appSubscriptionTrialExtend
"{\n \"days\": 1,\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: appSubscriptionTrialExtend
""
Display Examples for MUTATION: appSubscriptionTrialExtend
[
{
"example": {
"type_name": "appsubscriptiontrialextend",
"title": "Extend an app subscription for a shop",
"query_string": "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}",
"query_arguments": {
"id": "$id",
"days": "$days"
},
"variables": {
"id": "gid://shopify/AppSubscription/443388186",
"days": 10
},
"response": {
"data": {
"appSubscriptionTrialExtend": {
"userErrors": [],
"appSubscription": {
"id": "gid://shopify/AppSubscription/443388186",
"status": "ACTIVE"
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/billing/test/unit/graph_api/admin/mutations/app_subscription_trial_extend_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the app subscription to extend the trial for.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/AppSubscription/443388186\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "days",
"description": "The number of days to extend the trial. The value must be greater than 0 and less than or equal to 1000.",
"type": {
"kind": "SCALAR",
"name": "Int",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "Int!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "days",
"argValue": " 10",
"typeKind": "MUTATION"
}
]
}
]