Skip to main content
Anchor to MutationRoot

MutationRoot

object

The schema's entry-point for mutations. This acts as the public, top-level API from which all mutations must start.

Anchor to FieldsFields

Anchor to appCreditCreateappCreditCreate
•AppCreditCreatePayload

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.

Arguments

Anchor to appIdappId
•ID!
required

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

Anchor to shopIdshopId
•ID!
required

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

Anchor to amountamount
•MoneyInput!
required

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

Anchor to descriptiondescription
•String!
required

The description of the app credit.

Anchor to testtest
•Boolean
Default:false

Specifies whether the app credit is a test transaction.

Was this section helpful?