ApplicationCredit

Version 2019-10

The ApplicationCredit resource is used to issue credits to merchants that can be used towards future app purchases in Shopify. You can create an application credit by sending a request that includes the credit amount and a description explaining the reason for the credit. A corresponding deduction based on your revenue share is entered in your Partner account by Shopify. For example, if you create a credit for $10.00, then a deduction of $8.00 is applied.

The total amount of all application credits requested by an app must not exceed the total amount the shop owner was charged in the last 30 days, or the total amount of pending payouts in the app's Partner account.

Note

The ApplicationCredit resource can be used only by apps that use Shopify's Billing API (ApplicationCharge, RecurringApplicationCharge, or UsageCharge).

What you can do with ApplicationCredit

The Shopify API lets you do the following with the ApplicationCredit resource. More detailed versions of these general actions may be available:

ApplicationCredit properties

description
"description": "Super Mega Plan 1000 emails"

The description of the application credit.

id
"id": 675931192

The ID of the application credit.

amount
"amount": 10

The amount refunded by the application credit.

test
"test": null

Whether the application credit is a test transaction. Valid values: true,null

Endpoints

POST /admin/api/2019-10/application_credits.json
Creates an application credit

Applying a credit to a shop without a previous app purchase will return an error

POST /admin/api/2019-10/application_credits.json
{
  "application_credit": {
    "description": "application credit for refund",
    "amount": 5.0
  }
}
View Response
HTTP/1.1 422 Unprocessable Entity
{
  "errors": {
    "base": [
      "exceeded pending receivable credit issue limit (0.00)"
    ]
  }
}

Creating a credit amount that exceeds the total pending payouts for the app will return an error

POST /admin/api/2019-10/application_credits.json
{
  "application_credit": {