---
updatedAt: 2025-09-17T01:09:22.000Z
agentTools:
  projectIndex: https://docs.teachable.com/llms.txt
---

# /v1/transactions

Fetch a list of sales transactions made in your school. (New transactions can take up to two minutes to be returned via API call from the time of sale.)

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "title": "teachable-public-api",
    "description": "The documentation for the Teachable Public API. All endpoints are currently\nsubject to change.",
    "version": "0.0.1"
  },
  "paths": {
    "/v1/transactions": {
      "get": {
        "tags": [
          "Transactions"
        ],
        "description": "Fetch a list of sales transactions made in your school. (New transactions can take up to two minutes to be returned via API call from the time of sale.)",
        "operationId": "ListTransactions",
        "parameters": [
          {
            "name": "user_id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "affiliate_id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "course_id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "pricing_plan_id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "is_fully_refunded",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "is_chargeback",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "start",
            "in": "query",
            "description": "The beginning of the time period to return results for (exclusive), in ISO8601 format.",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "end",
            "in": "query",
            "description": "The end of the time period to return results for (inclusive), in ISO8601 format.",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Used in pagination when number of transactions exceed the maximum amount of results per page",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "per",
            "in": "query",
            "description": "Used in pagination to define amount of transactions per page, when not defined the maximum is 20",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200 response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListTransactionsResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PaginationMeta": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer",
            "format": "int32",
            "description": "The total number of items."
          },
          "page": {
            "type": "integer",
            "format": "int32",
            "description": "The current page."
          },
          "from": {
            "type": "integer",
            "format": "int32",
            "description": "First item number on page."
          },
          "to": {
            "type": "integer",
            "format": "int32",
            "description": "Last item number on page."
          },
          "per_page": {
            "type": "integer",
            "format": "int32",
            "description": "The number of items displayed per page."
          },
          "number_of_pages": {
            "type": "integer",
            "format": "int32",
            "description": "The total number of pages."
          }
        },
        "required": [
          "total",
          "page",
          "from",
          "to",
          "per_page",
          "number_of_pages"
        ]
      },
      "TransactionSummary": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "user_id": {
            "type": "integer",
            "format": "int32"
          },
          "pricing_plan_id": {
            "type": "integer",
            "format": "int32"
          },
          "sale_id": {
            "type": "integer",
            "format": "int32",
            "description": "Multiple transactions can be grouped to one sale"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "purchased_at": {
            "type": "string",
            "format": "date-time",
            "description": "Purchased at date could differ from created at date if part of a recurring pricing plan"
          },
          "charge": {
            "type": "integer",
            "format": "int32",
            "description": "The total charge price paid by the user, this is calculated in USD by default"
          },
          "final_price": {
            "type": "integer",
            "format": "int32",
            "description": "The listed price in currency of choice, excluding fees and taxes"
          },
          "currency": {
            "type": "string"
          },
          "tax_charge": {
            "type": "integer",
            "format": "int32",
            "description": "Taxes in currency of choice"
          },
          "revenue": {
            "type": "integer",
            "format": "int32",
            "description": "Total revenue collected, this is calculated in USD by default"
          },
          "status": {
            "type": "string",
            "nullable": true,
            "description": "The status of a transaction can be either paid or null (unpaid)"
          },
          "has_chargeback": {
            "type": "boolean",
            "nullable": true,
            "description": "A chargeback indicates the transaction was marked as fraudulent"
          },
          "chargeback_fee": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "affiliate_id": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "affiliate_fees": {
            "type": "integer",
            "format": "int32"
          },
          "author_id": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "author_fees": {
            "type": "integer",
            "format": "int32"
          },
          "coupon_id": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "refunded_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "amount_refunded": {
            "type": "integer",
            "format": "int32"
          }
        },
        "required": [
          "id",
          "user_id",
          "pricing_plan_id",
          "sale_id",
          "created_at",
          "purchased_at",
          "charge",
          "final_price",
          "currency",
          "tax_charge",
          "revenue",
          "status",
          "has_chargeback",
          "chargeback_fee",
          "affiliate_id",
          "affiliate_fees",
          "author_id",
          "author_fees",
          "coupon_id",
          "refunded_at",
          "amount_refunded"
        ]
      },
      "ListTransactionsResponse": {
        "type": "object",
        "properties": {
          "transactions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TransactionSummary"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/PaginationMeta"
          }
        },
        "required": [
          "transactions",
          "meta"
        ]
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "apiKey"
      }
    }
  },
  "servers": [
    {
      "url": "https://developers.teachable.com/",
      "description": "The production API server"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ]
}
```