Transaction details
The transaction system is a critical part of Kajabi’s payment infrastructure, handling all monetary operations while maintaining detailed records for accounting, reporting, and compliance purposes.
Transaction Attributes
provider(string) - The payment processor used for the paymentaction(string) - Indicate the type of transaction:charge- One-time paymentrefund- Money returned to customersubscribe- New subscriptionsubscription_charge- Recurring subscription paymentfree_purchase- $0 transactiontest- Test transactiondispute- Disputed chargesubscription_update- Subscription modification
state(string) - The transaction’s status:initialized- Transaction startedsucceeded- Transaction completed successfullyfailed- Transaction failed
payment_type(string) - Indicates the payment structure (nullable)amount_in_cents(integer) - The USD price in cents (for precise decimal handling) can be negative for refundssales_tax_in_cents(integer) - The USD sales tax in cents (for precise decimal handling)payment_fee_in_cents(integer) - Payment processing fee associated with the transaction (Kajabi Payments only)currency(string) - String representing the currency code (nullable) automatically upcased- Defaults to “USD” if not specified
currency_symbol(string) - String representing the currency symbol (nullable)- Example: ”$” for USD
formatted_amount(string) - String representing the amount in a human-readable format- Includes currency symbol
- Does not include currency code
- Example: “$19.99”
settlement_amount_in_cents(integer) - Price of the payment in cents based on the settlement currency (Kajabi Payments only)settlement_fee_amount_in_cents(integer) - Payment processing fee associated with the transaction based on the settlement currency (Kajabi Payments only)settlement_currency(string) - Currency of the payment based on settlement, typically the currency of the attached bank account (Kajabi Payments only)created_at(string) - The creation date and time, ISO date string format (read-only)
Sparse Fields
Use the fields[transactions] parameter to request only specific attributes:
Only return amount_in_cents and sales_tax_in_cents attributes
GET /v1/transactions/123?fields[transactions]=amount_in_cents,sales_tax_in_cents
Response will only include requested fields
Include Relationships
Use the include parameter to include related resources:
Deprecated: the
offerrelationship is deprecated and will be removed in a future version. It is only populated for single-offer transactions and isnullfor bundled (multi-offer) transactions. Use thepurchasesrelationship instead — it lists every offer purchase a transaction covers, for all transaction types.
Include customer and purchases relationships
GET /v1/transactions/123?include=customer,purchases
Response will include related resources
Using Multiple Parameters Together
You can combine sparse fields and include in a single request:
Get transaction with specific fields and included relationships
GET /v1/transactions/123?include=customer&fields[transactions]=amount_in_cents,sales_tax_in_cents&fields[customers]=name,email
Response will include transaction with only requested fields and included customer with only name and email fields
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Partial attributes as specified, e.g. fields[transactions]=amount_in_cents,sales_tax_in_cents
Load the related resources, for example ?include=customer,purchases