Mutation
The schema's entry-point for mutations. This acts as the public, top-level API from which all mutations must start.
Anchor to FieldsFields
- appCreditCreate (AppCreditCreatePayload)
- appSubscriptionCancel (AppSubscriptionCancelPayload)
- Anchor to appCreditCreateapp•App
Credit Create Credit Create Payload 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 financialspermission.- 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 appSubscriptionCancelapp•App
Subscription Cancel Subscription Cancel Payload Cancels an app subscription.
- Anchor to appIdapp•ID!
Id required The id of the app. Example value:
.- Anchor to deferCancellationdefer•Boolean!
Cancellation required Whether to defer cancellation until the end of the current billing cycle.
- Anchor to prorateprorate•Boolean!required
Whether to issue prorated credits for the unused portion of the subscription. Cannot be used together with
.- Anchor to shopIdshop•ID!
Id required The id of the shop. Example value:
.- Anchor to skipFinalUsageChargeskip•Boolean!
Final Usage Charge required Whether to skip the final usage charge when cancelling. Only applicable to usage-billed subscriptions. Cannot be used together with
prorate.
Arguments