Shopify

Shopify Charges API

The Charges API from Shopify — 18 operation(s) for charges.

GitHub OpenAPI

Documentation

📖
Documentation
https://shopify.dev/docs/api/admin-rest
📖
Documentation
https://shopify.dev/docs/api/ajax

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-charges-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-product-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-ld/shopify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-create-product-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/rules/shopify-rules.yml
🔗
Reference
https://shopify.dev/docs/api/ajax/reference

OpenAPI Specification

shopify-charges-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Charges 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: Charges
paths:
  /admin/api/2020-01/application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-01
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-04
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-07
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2020-10
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-2021-01
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#index-unstable
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/recurring_application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Recurring Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-01
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_recurring_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/recurring_application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Recurring Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-04
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_recurring_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/recurring_application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Recurring Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-07
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_recurring_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/recurring_application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Recurring Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2020-10
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: get_recurring_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/recurring_application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Recurring Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-2021-01
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_recurring_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/recurring_application_charges.json:
    get:
      summary: Shopify Retrieves A List Of Recurring Application Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#index-unstable
      parameters:
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_recurring_application_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json:
    get:
      summary: Shopify Retrieves A List Of Usage Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#index-2020-01
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json:
    get:
      summary: Shopify Retrieves A List Of Usage Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#index-2020-04
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json:
    get:
      summary: Shopify Retrieves A List Of Usage Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#index-2020-07
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json:
    get:
      summary: Shopify Retrieves A List Of Usage Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#index-2020-10
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: get_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json:
    get:
      summary: Shopify Retrieves A List Of Usage Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#index-2021-01
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json:
    get:
      summary: Shopify Retrieves A List Of Usage Charges
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#index-unstable
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      - in: query
        name: fields
        description: A comma-separated list of fields to include in the response.
        schema: {}
        required: false
      tags:
      - Charges
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      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