API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04 Unsupported
API version: 2020-01 Unsupported

appCreditCreate mutation

Version unstable

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-07 (Release candidate)

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Latest)

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04 (Unsupported)

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

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

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.


Arguments

Argument Description
amount ( MoneyInput! ) required

The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD.

description ( String! ) required

The description of the app credit.

test ( Boolean )

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

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appCredit (AppCredit)

    The newly created app credit.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.