startAppSubscriptionCheckout

Requires permission settings:apps:install.

Open a Stripe Checkout page (Growmax billing, US dollars) to buy a plan of an installed paid app. The app resumes once Stripe confirms payment.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation StartAppSubscriptionCheckout($input: StartAppSubscriptionCheckoutInput!) {
  startAppSubscriptionCheckout(input: $input) {
    plan
    sessionId
    url
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation StartAppSubscriptionCheckout($input: StartAppSubscriptionCheckoutInput!) {\n  startAppSubscriptionCheckout(input: $input) {\n    plan\n    sessionId\n    url\n  }\n}",
  "variables": {
    "input": {
      "cancelUrl": "string",
      "installationId": "id",
      "planHandle": "string",
      "successUrl": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "cancelUrl": "string",
    "installationId": "id",
    "planHandle": "string",
    "successUrl": "string"
  }
}

Response:

{
  "data": {
    "startAppSubscriptionCheckout": {
      "plan": "string",
      "sessionId": "string",
      "url": "string"
    }
  }
}

startAppSubscriptionCheckout(
  input: StartAppSubscriptionCheckoutInput!
): AppSubscriptionCheckoutSession!

Arguments

startAppSubscriptionCheckout.input ● StartAppSubscriptionCheckoutInput! non-null input

The installation, the plan and the return pages.

Type

AppSubscriptionCheckoutSession object

A Stripe Checkout page for an app plan.