List transactions

curl --request GET \
  --url https://api.kajabi.com/v1/transactions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.kajabi.com/v1/transactions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kajabi.com/v1/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.kajabi.com/v1/transactions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "action": "<string>",
        "state": "<string>",
        "payment_type": "<string>",
        "amount_in_cents": 123,
        "sales_tax_in_cents": 123,
        "currency": "<string>",
        "currency_symbol": "<string>",
        "formatted_amount": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "customer": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "offer": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "purchases": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Transactions

List transactions

List of payment transactions related to completed financial activity (successful charges, refunds, and disputes) that are associated with actual purchases, excluding test transactions, free purchases, failed attempts, and pending transactions.

Pagination

Use page[number] and page[size] parameters to paginate results:

Get first page of 10 items

GET /v1/transactions?page[number]=1&page[size]=10

Get second page of 25 items

GET /v1/transactions?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://api.kajabi.com/v1/transactions?page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/transactions?page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/transactions?page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/transactions?page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/transactions?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

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?fields[transactions]=amount_in_cents,sales_tax_in_cents

Response will only include requested fields

{
  "data": [{
    "id": "123",
    "type": "transactions",
    "attributes": {
      "amount_in_cents": 9900,
      "sales_tax_in_cents": 990
    }
  }]
}

Filtering

Use the filter[site_id] parameter to filter transactions by site:

Get transactions for site with ID 123

GET /v1/transactions?filter[site_id]=123

Response will include only transactions for the specified site

{
  "data": [{
    "id": "456",
    "type": "transactions",
    "attributes": {
      "amount_in_cents": 9900,
      "sales_tax_in_cents": 990,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Date Range Filtering

Use the filter[start_date] and filter[end_date] parameters to filter transactions by date range:

Get transactions between January 1st and January 31st, 2024

GET /v1/transactions?filter[start_date]=2024-01-01&filter[end_date]=2024-01-31

Response will include only transactions within the specified date range

{
  "data": [{
    "id": "456",
    "type": "transactions",
    "attributes": {
      "amount_in_cents": 9900,
      "sales_tax_in_cents": 990,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Filtering by Name or Email

Use the filter[name_or_email] parameter to filter transactions by name or email:

Get transactions for customer with name or email “John”

GET /v1/transactions?filter[name_or_email]=John

Filtering by Customer

Use the filter[customer_id] parameter to filter transactions by customer:

Get transactions for customer with ID 456789

GET /v1/transactions?filter[customer_id]=456789

Using Multiple Parameters Together

You can combine multiple parameters to filter and format the response:

Get paginated, filtered transactions with specific fields

GET /v1/transactions?page[number]=1&page[size]=10&fields[transactions]=amount_in_cents,sales_tax_in_cents&filter[site_id]=123&filter[start_date]=2024-01-01&filter[end_date]=2024-01-31

Response will include paginated transactions matching all filters, with only requested fields:

{
  "data": [{
    "id": "456",
    "type": "transactions",
    "attributes": {
      "amount_in_cents": 9900,
      "sales_tax_in_cents": 990
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }],
  "meta": {
    "total_pages": 1,
    "current_page": 1
  }
}

GET

transactions

List transactions

curl --request GET \
  --url https://api.kajabi.com/v1/transactions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.kajabi.com/v1/transactions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kajabi.com/v1/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.kajabi.com/v1/transactions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "action": "<string>",
        "state": "<string>",
        "payment_type": "<string>",
        "amount_in_cents": 123,
        "sales_tax_in_cents": 123,
        "currency": "<string>",
        "currency_symbol": "<string>",
        "formatted_amount": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "customer": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "offer": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "purchases": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[number]

number

page[size]

number

Number of documents

fields[transactions]

string

Partial attributes as specified, e.g. fields[transactions]=amount_in_cents,sales_tax_in_cents

filter[site_id]

string

Filter by site_id, for example ?filter[site_id]=111

filter[customer_id]

string

Filter by customer_id, for example ?filter[customer_id]=456789

filter[name_or_email]

string

Filter by name or email, for example ?filter[name_or_email]=John

filter[start_date]

string

Filter by start_date, for example ?filter[start_date]=2024-12-01

filter[end_date]

string

Filter by end_date, for example ?filter[end_date]=2024-12-31

Response

Success, lists transactions which the current user may access

data

object[]

Show child attributes

links

object

Show child attributes

Website page details

Transaction details