Choose a version:

appSubscriptionTrialExtend

mutation

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

Extends the trial period for an existing app subscription. Trial extensions give merchants additional time to use the app before committing to paid billing.

Requires the subscription ID and the number of days to extend (between one and 1000). The extension modifies the existing trial end date, allowing continued access to subscription features without immediate billing. Returns the updated AppSubscription.

Learn more about offering free trials.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to AppSubscriptionTrialExtendPayload returnsAppSubscriptionTrialExtendPayload returns

Anchor to appSubscriptionappSubscription •AppSubscription: The app subscription that had its trial extended.
Anchor to userErrorsuserErrors •[AppSubscriptionTrialExtendUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Extend an app subscription for a shop

Query

mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {
  appSubscriptionTrialExtend(id: $id, days: $days) {
    userErrors {
      field
      message
      code
    }
    appSubscription {
      id
      status
    }
  }
}

Variables

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) { appSubscriptionTrialExtend(id: $id, days: $days) { userErrors { field message code } appSubscription { id status } } }",
 "variables": {
    "id": "gid://shopify/AppSubscription/443388186",
    "days": 10
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {
    appSubscriptionTrialExtend(id: $id, days: $days) {
      userErrors {
        field
        message
        code
      }
      appSubscription {
        id
        status
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/AppSubscription/443388186",
        "days": 10
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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
  mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {
    appSubscriptionTrialExtend(id: $id, days: $days) {
      userErrors {
        field
        message
        code
      }
      appSubscription {
        id
        status
      }
    }
  }
QUERY

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

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {
      appSubscriptionTrialExtend(id: $id, days: $days) {
        userErrors {
          field
          message
          code
        }
        appSubscription {
          id
          status
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/AppSubscription/443388186",
        "days": 10
    },
  },
});

Response

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

appSubscriptionTrialExtend reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {

appSubscriptionTrialExtend(id: $id, days: $days) {

userErrors {

field

message

code

}

appSubscription {

status

}

}`,

{

variables: {

"id": "gid://shopify/AppSubscription/443388186",

"days": 10

);

const json = await response.json();

return json.data;

}

GQL

mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {
  appSubscriptionTrialExtend(id: $id, days: $days) {
    userErrors {
      field
      message
      code
    }
    appSubscription {
      id
      status
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) { appSubscriptionTrialExtend(id: $id, days: $days) { userErrors { field message code } appSubscription { id status } } }",
 "variables": {
    "id": "gid://shopify/AppSubscription/443388186",
    "days": 10
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {
    appSubscriptionTrialExtend(id: $id, days: $days) {
      userErrors {
        field
        message
        code
      }
      appSubscription {
        id
        status
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/AppSubscription/443388186",
        "days": 10
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {
      appSubscriptionTrialExtend(id: $id, days: $days) {
        userErrors {
          field
          message
          code
        }
        appSubscription {
          id
          status
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/AppSubscription/443388186",
        "days": 10
    },
  },
});

Ruby

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
  mutation AppSubscriptionTrialExtend($id: ID!, $days: Int!) {
    appSubscriptionTrialExtend(id: $id, days: $days) {
      userErrors {
        field
        message
        code
      }
      appSubscription {
        id
        status
      }
    }
  }
QUERY

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

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

Input variables

JSON

{

"id": "gid://shopify/AppSubscription/443388186",

"days": 10

}

Response

JSON

{

"appSubscriptionTrialExtend": {

"userErrors": [],

"appSubscription": {

"id": "gid://shopify/AppSubscription/443388186",

"status": "ACTIVE"

}