Shopify Usage API

The Usage API from Shopify — 6 operation(s) for usage.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

shopify-usage-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Shopify Admin REST About Usage 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: Usage
paths:
  /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  usage_charge:
                    description: Super Mega Plan 1000 emails
                    price: 1
                summary: Create a new usage charge
              example2:
                value:
                  usage_charge:
                    description: ''
                summary: Trying to create a charge without a price and description will return an error
      summary: Shopify Creates A Usage Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-01
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Usage
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    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:
      - Usage
      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:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  usage_charge:
                    description: Super Mega Plan 1000 emails
                    price: 1
                summary: Create a new usage charge
              example2:
                value:
                  usage_charge:
                    description: ''
                summary: Trying to create a charge without a price and description will return an error
      summary: Shopify Creates A Usage Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-04
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Usage
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    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:
      - Usage
      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:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  usage_charge:
                    description: Super Mega Plan 1000 emails
                    price: 1
                summary: Create a new usage charge
              example2:
                value:
                  usage_charge:
                    description: ''
                summary: Trying to create a charge without a price and description will return an error
      summary: Shopify Creates A Usage Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-07
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Usage
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    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:
      - Usage
      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:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  usage_charge:
                    description: Super Mega Plan 1000 emails
                    price: 1
                summary: Create a new usage charge
              example2:
                value:
                  usage_charge:
                    description: ''
                summary: Trying to create a charge without a price and description will return an error
      summary: Shopify Creates A Usage Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2020-10
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Usage
      responses:
        '200':
          description: ''
      operationId: create_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    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:
      - Usage
      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:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  usage_charge:
                    description: Super Mega Plan 1000 emails
                    price: 1
                summary: Create a new usage charge
              example2:
                value:
                  usage_charge:
                    description: ''
                summary: Trying to create a charge without a price and description will return an error
      summary: Shopify Creates A Usage Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-2021-01
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Usage
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    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:
      - Usage
      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:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  usage_charge:
                    description: Super Mega Plan 1000 emails
                    price: 1
                summary: Create a new usage charge
              example2:
                value:
                  usage_charge:
                    description: ''
                summary: Trying to create a charge without a price and description will return an error
      summary: Shopify Creates A Usage Charge
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/usagecharge#create-unstable
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Usage
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_recurring_application_charges_param_recurring_application_charge_id_usage_charges
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    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:
      - Usage
      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