appPurchaseOneTimeCreate
mutation

Choose a version:

Charges a shop for features or services one time. This type of charge is recommended for apps that aren't billed on a recurring basis. Test and demo shops aren't charged.

Anchor to section titled 'Arguments'

Arguments

Anchor to name name String! required: The name of the one-time purchase from the app.
Anchor to price price MoneyInput! required: The amount to be charged to the store for the app one-time purchase.
Anchor to returnUrl returnUrl URL! required: The URL where the merchant is redirected after approving the app one-time purchase.
Anchor to test test Boolean default:false: Whether the app one-time purchase is a test transaction.

Was this section helpful?

Anchor to section titled 'AppPurchaseOneTimeCreatePayload returns'

AppPurchaseOneTimeCreatePayload returns

Anchor to AppPurchaseOneTimeCreatePayload.appPurchaseOneTime appPurchaseOneTime AppPurchaseOneTime: The newly created app one-time purchase.
Anchor to AppPurchaseOneTimeCreatePayload.confirmationUrl confirmationUrl URL: The URL that the merchant can access to approve or decline the newly created app one-time purchase.

If the merchant declines, then the merchant is redirected to the app and receives a notification message stating that the charge was declined. If the merchant approves and they're successfully invoiced, then the state of the charge changes from pending to active.

You get paid after the charge is activated.
Anchor to AppPurchaseOneTimeCreatePayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: appPurchaseOneTimeCreate

Query Reference for MUTATION: appPurchaseOneTimeCreate

"mutation appPurchaseOneTimeCreate($name: String!, $price: MoneyInput!, $returnUrl: URL!) {\n  appPurchaseOneTimeCreate(name: $name, price: $price, returnUrl: $returnUrl) {\n    appPurchaseOneTime {\n      # AppPurchaseOneTime fields\n    }\n    confirmationUrl\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: appPurchaseOneTimeCreate

"{\n  \"name\": \"<your-name>\",\n  \"price\": {\n    \"amount\": \"29.99\",\n    \"currencyCode\": \"AED\"\n  },\n  \"returnUrl\": \"https://example.myshopify.com\",\n  \"test\": true\n}"

Schema Reference for MUTATION: appPurchaseOneTimeCreate

"input MoneyInput {\n  amount: Decimal!\n  currencyCode: CurrencyCode!\n}\n"

Display Examples for MUTATION: appPurchaseOneTimeCreate

[
  {
    "example": {
      "type_name": "apppurchaseonetimecreate",
      "title": "Create a one-time app purchase.",
      "description": "Summarizes the service rendered in the `name` field.",
      "query_string": "mutation AppPurchaseOneTimeCreate($name: String!, $price: MoneyInput!, $returnUrl: URL!) {\n  appPurchaseOneTimeCreate(name: $name, returnUrl: $returnUrl, price: $price) {\n    userErrors {\n      field\n      message\n    }\n    appPurchaseOneTime {\n      createdAt\n      id\n    }\n    confirmationUrl\n  }\n}",
      "query_arguments": {
        "name": "$name",
        "returnUrl": "$returnUrl",
        "price": "$price"
      },
      "variables": {
        "name": "1000 imported orders.",
        "returnUrl": "http://super-duper.shopifyapps.com/",
        "price": {
          "amount": 10,
          "currencyCode": "USD"
        }
      },
      "response": {
        "data": {
          "appPurchaseOneTimeCreate": {
            "userErrors": [],
            "appPurchaseOneTime": {
              "createdAt": "2024-09-12T01:06:28Z",
              "id": "gid://shopify/AppPurchaseOneTime/1017262347"
            },
            "confirmationUrl": "https://billingshop.myshopify.com/admin/charges/193172482/1017262347/ApplicationCharge/confirm_application_charge?signature=BAh7BzoHaWRpBAsxojw6EmF1dG9fYWN0aXZhdGVU--aeb4a428c6bc3d3759488f6ec246fe61dc15a422"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/billing/test/unit/graph_api/admin/mutations/app_purchase_one_time_create_test.rb",
      "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 AppPurchaseOneTimeCreate($name: String!, $price: MoneyInput!, $returnUrl: URL!) { appPurchaseOneTimeCreate(name: $name, returnUrl: $returnUrl, price: $price) { userErrors { field message } appPurchaseOneTime { createdAt id } confirmationUrl } }\",\n \"variables\": {\n    \"name\": \"1000 imported orders.\",\n    \"returnUrl\": \"http://super-duper.shopifyapps.com/\",\n    \"price\": {\n      \"amount\": 10.0,\n      \"currencyCode\": \"USD\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation AppPurchaseOneTimeCreate($name: String!, $price: MoneyInput!, $returnUrl: URL!) {\n    appPurchaseOneTimeCreate(name: $name, returnUrl: $returnUrl, price: $price) {\n      userErrors {\n        field\n        message\n      }\n      appPurchaseOneTime {\n        createdAt\n        id\n      }\n      confirmationUrl\n    }\n  }`,\n  {\n    variables: {\n      \"name\": \"1000 imported orders.\",\n      \"returnUrl\": \"http://super-duper.shopifyapps.com/\",\n      \"price\": {\n        \"amount\": 10.0,\n        \"currencyCode\": \"USD\"\n      }\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 AppPurchaseOneTimeCreate($name: String!, $price: MoneyInput!, $returnUrl: URL!) {\n    appPurchaseOneTimeCreate(name: $name, returnUrl: $returnUrl, price: $price) {\n      userErrors {\n        field\n        message\n      }\n      appPurchaseOneTime {\n        createdAt\n        id\n      }\n      confirmationUrl\n    }\n  }\nQUERY\n\nvariables = {\n  \"name\": \"1000 imported orders.\",\n  \"returnUrl\": \"http://super-duper.shopifyapps.com/\",\n  \"price\": {\n    \"amount\": 10.0,\n    \"currencyCode\": \"USD\"\n  }\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 AppPurchaseOneTimeCreate($name: String!, $price: MoneyInput!, $returnUrl: URL!) {\n      appPurchaseOneTimeCreate(name: $name, returnUrl: $returnUrl, price: $price) {\n        userErrors {\n          field\n          message\n        }\n        appPurchaseOneTime {\n          createdAt\n          id\n        }\n        confirmationUrl\n      }\n    }`,\n    \"variables\": {\n      \"name\": \"1000 imported orders.\",\n      \"returnUrl\": \"http://super-duper.shopifyapps.com/\",\n      \"price\": {\n        \"amount\": 10.0,\n        \"currencyCode\": \"USD\"\n      }\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 AppPurchaseOneTimeCreate($name: String!, $price: MoneyInput!, $returnUrl: URL!) {\n    appPurchaseOneTimeCreate(name: $name, returnUrl: $returnUrl, price: $price) {\n      userErrors {\n        field\n        message\n      }\n      appPurchaseOneTime {\n        createdAt\n        id\n      }\n      confirmationUrl\n    }\n  }\nQUERY;\n\n$variables = [\n  \"name\" => \"1000 imported orders.\",\n  \"returnUrl\" => \"http://super-duper.shopifyapps.com/\",\n  \"price\" => [\n    \"amount\" => 10.0,\n    \"currencyCode\" => \"USD\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "name",
          "description": "The name of the one-time purchase from the app.",
          "type": {
            "kind": "SCALAR",
            "name": "String",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "String!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "name",
        "argValue": " \"1000 imported orders.\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "returnUrl",
          "description": "The URL where the merchant is redirected after approving the app one-time purchase.",
          "type": {
            "kind": "SCALAR",
            "name": "URL",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "URL!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "returnUrl",
        "argValue": " \"http://super-duper.shopifyapps.com/\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "price",
          "description": "The amount to be charged to the store for the app one-time purchase.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "MoneyInput",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "MoneyInput!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "price",
        "argValue": " {\"amount\":10,\"currencyCode\":\"USD\"}",
        "typeKind": "MUTATION"
      }
    ]
  }
]

appPurchaseOneTimeCreatemutation

Arguments

AppPurchaseOneTimeCreatePayload returns

appPurchaseOneTimeCreate
mutation