openapi: 3.1.0
info:
  title: Shopify Admin REST About Credit API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
security:
- AccessToken: []
tags:
- name: Credit
paths:
  /admin/api/2020-01/application_credits.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Create a new credit
              example2:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                    test: true
                summary: Create a test application credit that will not issue a credit to the merchant
              example3:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds shop owner purchases over last 30 days will return an error
              example4:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Applying a credit to a shop without a previous app purchase will return an error
              example5:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds the total pending payouts for the app will return an error
      summary: Shopify Creates An Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-01
      parameters: []
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/application_credits/{application_credit_id}.json:
    get:
      summary: Shopify Retrieves A Single Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-01
      parameters:
      - in: path
        name: application_credit_id
        required: true
        schema:
          type: string
        description: application_credit_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_application_credits_param_application_credit_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/application_credits.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Create a new credit
              example2:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                    test: true
                summary: Create a test application credit that will not issue a credit to the merchant
              example3:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds shop owner purchases over last 30 days will return an error
              example4:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Applying a credit to a shop without a previous app purchase will return an error
              example5:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds the total pending payouts for the app will return an error
      summary: Shopify Creates An Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-04
      parameters: []
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/application_credits/{application_credit_id}.json:
    get:
      summary: Shopify Retrieves A Single Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-04
      parameters:
      - in: path
        name: application_credit_id
        required: true
        schema:
          type: string
        description: application_credit_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_application_credits_param_application_credit_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/application_credits.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Create a new credit
              example2:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                    test: true
                summary: Create a test application credit that will not issue a credit to the merchant
              example3:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds shop owner purchases over last 30 days will return an error
              example4:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Applying a credit to a shop without a previous app purchase will return an error
              example5:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds the total pending payouts for the app will return an error
      summary: Shopify Creates An Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-07
      parameters: []
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/application_credits/{application_credit_id}.json:
    get:
      summary: Shopify Retrieves A Single Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-07
      parameters:
      - in: path
        name: application_credit_id
        required: true
        schema:
          type: string
        description: application_credit_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_application_credits_param_application_credit_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/application_credits.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Create a new credit
              example2:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                    test: true
                summary: Create a test application credit that will not issue a credit to the merchant
              example3:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds shop owner purchases over last 30 days will return an error
              example4:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Applying a credit to a shop without a previous app purchase will return an error
              example5:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds the total pending payouts for the app will return an error
      summary: Shopify Creates An Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2020-10
      parameters: []
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: create_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/application_credits/{application_credit_id}.json:
    get:
      summary: Shopify Retrieves A Single Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2020-10
      parameters:
      - in: path
        name: application_credit_id
        required: true
        schema:
          type: string
        description: application_credit_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: get_application_credits_param_application_credit_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/application_credits.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Create a new credit
              example2:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                    test: true
                summary: Create a test application credit that will not issue a credit to the merchant
              example3:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds shop owner purchases over last 30 days will return an error
              example4:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Applying a credit to a shop without a previous app purchase will return an error
              example5:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds the total pending payouts for the app will return an error
      summary: Shopify Creates An Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-2021-01
      parameters: []
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/application_credits/{application_credit_id}.json:
    get:
      summary: Shopify Retrieves A Single Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-2021-01
      parameters:
      - in: path
        name: application_credit_id
        required: true
        schema:
          type: string
        description: application_credit_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_application_credits_param_application_credit_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/application_credits.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Create a new credit
              example2:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                    test: true
                summary: Create a test application credit that will not issue a credit to the merchant
              example3:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds shop owner purchases over last 30 days will return an error
              example4:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Applying a credit to a shop without a previous app purchase will return an error
              example5:
                value:
                  application_credit:
                    description: application credit for refund
                    amount: 5
                summary: Creating a credit amount that exceeds the total pending payouts for the app will return an error
      summary: Shopify Creates An Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#create-unstable
      parameters: []
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_application_credits
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/application_credits/{application_credit_id}.json:
    get:
      summary: Shopify Retrieves A Single Application Credit
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcredit#show-unstable
      parameters:
      - in: path
        name: application_credit_id
        required: true
        schema:
          type: string
        description: application_credit_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Credit
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_application_credits_param_application_credit_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth