The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

ApplicationCredit

Important

Creating application credits through this resource is being deprecated. App credits can continue to be created using the appCreditCreate mutation in the Partner API.

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).

Was this section helpful?
Anchor to section titled 'The ApplicationCredit resource'

The ApplicationCredit resource

Properties
description
->description
The description of the application credit.
id
->id
The ID of the application credit.
amount
string
->amount
The amount refunded by the application credit.
test
->test
Whether the application credit is a test transaction. Valid values: true,null
currency
->amount
The currency of the application credit amount.
Was this section helpful?
{}The ApplicationCredit resource
{
  "description": "Super Mega Plan 1000 emails",
  "id": 675931192,
  "amount": "10",
  "test": null,
  "currency": "USD"
}
Anchor to section titled 'GET request, Retrieves all application credits'

get
Retrieves all application credits

appInstallation
Retrieves all application credits
Anchor to section titled 'Parameters of Retrieves all application credits'

Parameters

api_version
string
required
fields
A comma-separated list of fields to include in the response.
Was this section helpful?
Anchor to section titled 'Examples of Retrieves all application credits'

Examples

Was this section helpful?
get
/admin/api/2024-10/application_credits.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/application_credits.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "application_credits": [
    {
      "id": 140583599,
      "amount": "5.00",
      "description": "credit for application refund",
      "test": null,
      "currency": "USD"
    }
  ]
}
Anchor to section titled 'GET request, Retrieves a single application credit'

get
Retrieves a single application credit

appInstallation
Retrieves a single application credit
Anchor to section titled 'Parameters of Retrieves a single application credit'

Parameters

api_version
string
required
application_credit_id
string
required
fields
A comma-separated list of fields to include in the response.
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a single application credit'

Examples

Path parameters
applicationcreditid=140583599
string
required
Was this section helpful?
get
/admin/api/2024-10/application_credits/140583599.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/application_credits/140583599.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "application_credit": {
    "id": 140583599,
    "amount": "5.00",
    "description": "credit for application refund",
    "test": null,
    "currency": "USD"
  }
}