App Credit
A credit issued to a merchant for an app. Merchants are entitled to app credits under certain circumstances, such as when a paid app subscription is downgraded partway through its billing cycle.
Anchor to FieldsFields
- Anchor to amountamount•Money!non-null
The amount that can be used towards future app purchases in Shopify.
- •ID!non-null
A globally unique identifier.
- Anchor to namename•String!non-null
The description of the app credit.
- Anchor to testtest•Boolean!non-null
Whether the app credit was a test transaction.
Anchor to MutationsMutations
- •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 amountamount•Money
Input! required The amount that can be used towards future app purchases in Shopify.
- Anchor to appIdapp•ID!
Id required The id of the app to associate the credit with. Example value:
.
- Anchor to descriptiondescription•String!required
The description of the app credit.
- Anchor to shopIdshop•ID!
Id required The id of the shop to be credited. Example value:
.
- Anchor to testtest•BooleanDefault:false
Specifies whether the app credit is a test transaction.
Arguments
- Anchor to appCreditapp•App
Credit Credit The app credit that was created.
- Anchor to userErrorsuser•[User
Errors Error!] Errors when creating the application credit.
Fields