TransactionsAPI

Defined in: v1/transactions.ts:13

Handles all transaction-related API operations. Intended to be instantiated by a parent API client that provides the base fetch logic.

Constructors

Constructor

new TransactionsAPI(baseFetch): TransactionsAPI

Defined in: v1/transactions.ts:22

Creates a new TransactionsAPI instance.

Parameters

baseFetch

<T>(endpoint, schema) => Promise<T>

A generic fetch function provided by the parent client. Handles request execution and response validation against a Zod schema.

Returns

TransactionsAPI

Example

const transactions = new TransactionsAPI((endpoint, schema) => myClient.fetch(endpoint, schema));

Methods

getById()

getById(id): Promise<{ 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/transactions.ts:85

Retrieves a single transaction by its unique numeric ID.

Parameters

id

number

The unique identifier of the transaction.

Returns

Promise<{ 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; }>

A promise resolving to a validated Transaction object.

Throws

If no transaction exists with the given ID or the request fails.

Example

const transaction = await transactionsAPI.getById(101);

---

getList()

getList(page?, per?, filters?): Promise<{ meta?: { from?: number; number_of_pages?: number; page?: number; per_page?: number; to?: number; total?: number; }; 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/transactions.ts:50

Retrieves a paginated list of transactions with optional filters. All filter parameters are optional and can be combined freely.

Parameters

page?

number = 1

The page number to retrieve. Defaults to 1.

per?

number = 20

The number of results per page. Defaults to 20, maximum: 100.

filters?

Optional filters to apply to the query.

affiliateId?

number

If provided, restricts results to transactions for this affiliate.

courseId?

number

If provided, restricts results to transactions for this course.

endDate?

string

If provided, restricts results to transactions on or before this date (ISO 8601).

isChargeback?

boolean

If true, returns only chargeback transactions.

isFullyRefunded?

boolean

If true, returns only fully refunded transactions.

pricingPlanId?

number

If provided, restricts results to transactions for this pricing plan.

startDate?

string

If provided, restricts results to transactions on or after this date (ISO 8601).

userId?

number

If provided, restricts results to transactions belonging to this user.

Returns

Promise<{ meta?: { from?: number; number_of_pages?: number; page?: number; per_page?: number; to?: number; total?: number; }; 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; }[]; }>

A promise resolving to a validated TransactionsResponse object.

Example

// All transactions, first page
const all = await transactionsAPI.getList();

// Refunded transactions for a specific user and course
const filtered = await transactionsAPI.getList(1, 20, {
    userId: 99,
    courseId: 42,
    isFullyRefunded: true,
});