Skip to content
Optio Docs

TransactionsResponse

Defined in: v1/schemas.ts:182

The paginated wrapper object returned by Teachable transaction endpoints. Includes full pagination metadata.

Remarks

Section titled “Remarks”

The Teachable v1 API does not provide a single transaction endpoint. Transactions can only be retrieved via the list endpoint using filters such as userId, courseId, or date range.

Processing delay — new transactions can take up to two minutes to appear via the API from the time of sale. Do not rely on this endpoint for real-time payment confirmation.

Extends

Section titled “Extends”
  • output<typeof TransactionsResponseSchema>

Properties

Section titled “Properties”

meta?

Section titled “meta?”

optional meta?: { from?: number; number_of_pages?: number; page?: number; per_page?: number; to?: number; total?: number; }

Defined in: v1/schemas.ts:166

from?

Section titled “from?”

optional from?: number

number_of_pages?

Section titled “number_of_pages?”

optional number_of_pages?: number

page?

Section titled “page?”

optional page?: number

per_page?

Section titled “per_page?”

optional per_page?: number

to?

Section titled “to?”

optional to?: number

total?

Section titled “total?”

optional total?: number

Inherited from

Section titled “Inherited from”

z.infer.meta

transactions

Section titled “transactions”

transactions: { affiliate_fees?: number | null; affiliate_id?: number | null; amount_refunded?: number; author_fees?: number | null; author_id?: number | null; charge: number; chargeback_fee?: number | null; coupon_id?: number | null; created_at: string; currency: string; final_price: number; has_chargeback?: boolean | null; id: number; pricing_plan_id?: number; purchased_at?: string; refunded_at?: string | null; revenue?: number; sale_id?: number; status?: string | null; tax_charge?: number; user_id: number; }[]

Defined in: v1/schemas.ts:165

affiliate_fees?

Section titled “affiliate_fees?”

optional affiliate_fees?: number | null

affiliate_id?

Section titled “affiliate_id?”

optional affiliate_id?: number | null

amount_refunded?

Section titled “amount_refunded?”

optional amount_refunded?: number

author_fees?

Section titled “author_fees?”

optional author_fees?: number | null

author_id?

Section titled “author_id?”

optional author_id?: number | null

charge

Section titled “charge”

charge: number

chargeback_fee?

Section titled “chargeback_fee?”

optional chargeback_fee?: number | null

coupon_id?

Section titled “coupon_id?”

optional coupon_id?: number | null

created_at

Section titled “created_at”

created_at: string

currency

Section titled “currency”

currency: string

final_price

Section titled “final_price”

final_price: number

has_chargeback?

Section titled “has_chargeback?”

optional has_chargeback?: boolean | null

id

Section titled “id”

id: number

pricing_plan_id?

Section titled “pricing_plan_id?”

optional pricing_plan_id?: number

purchased_at?

Section titled “purchased_at?”

optional purchased_at?: string

refunded_at?

Section titled “refunded_at?”

optional refunded_at?: string | null

revenue?

Section titled “revenue?”

optional revenue?: number

sale_id?

Section titled “sale_id?”

optional sale_id?: number

status?

Section titled “status?”

optional status?: string | null

tax_charge?

Section titled “tax_charge?”

optional tax_charge?: number

user_id

Section titled “user_id”

user_id: number

Inherited from

Section titled “Inherited from”

z.infer.transactions