Choose a version:

appCreditCreate

mutation

Allows an app to create a credit for a shop that can be used towards future app purchases. This mutation is only available to Partner API clients that have been granted the View financials permission.

Anchor to Arguments

Arguments

Anchor to amountamount

•MoneyInput!

required

The amount that can be used towards future app purchases in Shopify.

Anchor to appIdappId

•ID!

required

The id of the app to associate the credit with. Example value: gid://partners/App/123.

Anchor to descriptiondescription

•String!

required

The description of the app credit.

Anchor to shopIdshopId

•ID!

required

The id of the shop to be credited. Example value: gid://partners/Shop/456.

Anchor to testtest

•Boolean

Default:false

Specifies whether the app credit is a test transaction.

Was this section helpful?

Anchor to AppCreditCreatePayload returnsAppCreditCreatePayload returns

Anchor to appCreditappCredit •AppCredit: The app credit that was created.
Anchor to userErrorsuserErrors •[UserError!]: Errors when creating the application credit.

Was this section helpful?

Examples

appCreditCreate reference

Mutation Reference

mutation appCreditCreate($appId: ID!, $shopId: ID!, $amount: MoneyInput!, $description: String!, $test: Boolean) {

appCreditCreate(appId: $appId, shopId: $shopId, amount: $amount, description: $description, test: $test) {

appCredit {

# AppCredit fields

}

userErrors {

field

message

}

Input

{

"appId": "gid://shopify/<objectName>/10079785100",

"shopId": "gid://shopify/<objectName>/10079785100",

"amount": {

"amount": "29.99",

"currencyCode": "CYP"

"description": "<your-description>",

"test": true

}

Variables

{
  "appId": "gid://shopify/<objectName>/10079785100",
  "shopId": "gid://shopify/<objectName>/10079785100",
  "amount": {
    "amount": "29.99",
    "currencyCode": "CYP"
  },
  "description": "<your-description>",
  "test": true
}

Schema

input MoneyInput {
  amount: Decimal
  currencyCode: Currency
}