appCreditCreate mutation

Allows an app to create a credit for a shop that can be used towards future app purchases.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation appCreditCreate($description: String!, $amount: MoneyInput!) { appCreditCreate(description: $description, amount: $amount) { 
  1. <font style="color:#1F61A0;">appCredit</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “description”: “placeholder”, “amount”: { 
  1. <font style="color:#8B2BB9;">"amount"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"currencyCode"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
} }

Arguments

Argument Description
amount
(
[MoneyInput!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyinput)

) REQUIRED		 The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.
description
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 The description of the app credit.
test
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Specifies whether the app credit is a test transaction.
Default value: false

MoneyInput fields

  • amount ([Decimal!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#decimal-2021-01)) REQUIRED
    Decimal money amount.
  • currencyCode ([CurrencyCode!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode)) REQUIRED
    Currency of the money.

Return fields

  • appCredit ([AppCredit](https://shopify.dev/docs/admin-api/graphql/reference/billing/appcredit))
    The newly created app credit.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.