Transaction
Defined in: v1/schemas.ts:161
A single transaction object as returned by the Teachable v1 API.
Financial fields (charge, final_price, tax_charge etc.) are returned
as integers representing the smallest currency unit (e.g. cents), so a value
of 66045 represents $660.45.
Several fields are nullable as Teachable may omit or null them depending on the transaction type (e.g. refunds, affiliate transactions, chargebacks).
Extends
Section titled “Extends”output<typeofTransactionSchema>
Properties
Section titled “Properties”affiliate_fees?
Section titled “affiliate_fees?”
optionalaffiliate_fees?:number|null
Defined in: v1/schemas.ts:137
Inherited from
Section titled “Inherited from”z.infer.affiliate_fees
affiliate_id?
Section titled “affiliate_id?”
optionalaffiliate_id?:number|null
Defined in: v1/schemas.ts:147
Inherited from
Section titled “Inherited from”z.infer.affiliate_id
amount_refunded?
Section titled “amount_refunded?”
optionalamount_refunded?:number
Defined in: v1/schemas.ts:135
Inherited from
Section titled “Inherited from”z.infer.amount_refunded
author_fees?
Section titled “author_fees?”
optionalauthor_fees?:number|null
Defined in: v1/schemas.ts:138
Inherited from
Section titled “Inherited from”z.infer.author_fees
author_id?
Section titled “author_id?”
optionalauthor_id?:number|null
Defined in: v1/schemas.ts:148
Inherited from
Section titled “Inherited from”z.infer.author_id
charge
Section titled “charge”charge:
number
Defined in: v1/schemas.ts:131
Inherited from
Section titled “Inherited from”z.infer.charge
chargeback_fee?
Section titled “chargeback_fee?”
optionalchargeback_fee?:number|null
Defined in: v1/schemas.ts:136
Inherited from
Section titled “Inherited from”z.infer.chargeback_fee
coupon_id?
Section titled “coupon_id?”
optionalcoupon_id?:number|null
Defined in: v1/schemas.ts:146
Inherited from
Section titled “Inherited from”z.infer.coupon_id
created_at
Section titled “created_at”created_at:
string
Defined in: v1/schemas.ts:126
Inherited from
Section titled “Inherited from”z.infer.created_at
currency
Section titled “currency”currency:
string
Defined in: v1/schemas.ts:141
Inherited from
Section titled “Inherited from”z.infer.currency
final_price
Section titled “final_price”final_price:
number
Defined in: v1/schemas.ts:132
Inherited from
Section titled “Inherited from”z.infer.final_price
has_chargeback?
Section titled “has_chargeback?”
optionalhas_chargeback?:boolean|null
Defined in: v1/schemas.ts:143
Inherited from
Section titled “Inherited from”z.infer.has_chargeback
id:
number
Defined in: v1/schemas.ts:120
Inherited from
Section titled “Inherited from”z.infer.id
pricing_plan_id?
Section titled “pricing_plan_id?”
optionalpricing_plan_id?:number
Defined in: v1/schemas.ts:122
Inherited from
Section titled “Inherited from”z.infer.pricing_plan_id
purchased_at?
Section titled “purchased_at?”
optionalpurchased_at?:string
Defined in: v1/schemas.ts:127
Inherited from
Section titled “Inherited from”z.infer.purchased_at
refunded_at?
Section titled “refunded_at?”
optionalrefunded_at?:string|null
Defined in: v1/schemas.ts:128
Inherited from
Section titled “Inherited from”z.infer.refunded_at
revenue?
Section titled “revenue?”
optionalrevenue?:number
Defined in: v1/schemas.ts:134
Inherited from
Section titled “Inherited from”z.infer.revenue
sale_id?
Section titled “sale_id?”
optionalsale_id?:number
Defined in: v1/schemas.ts:123
Inherited from
Section titled “Inherited from”z.infer.sale_id
status?
Section titled “status?”
optionalstatus?:string|null
Defined in: v1/schemas.ts:142
Inherited from
Section titled “Inherited from”z.infer.status
tax_charge?
Section titled “tax_charge?”
optionaltax_charge?:number
Defined in: v1/schemas.ts:133
Inherited from
Section titled “Inherited from”z.infer.tax_charge
user_id
Section titled “user_id”user_id:
number
Defined in: v1/schemas.ts:121
Inherited from
Section titled “Inherited from”z.infer.user_id