Accounting API Instalments

List all instalment plans

GET https://api.tamio.com/v2/instalments/list

Returns a paginated list of instalment plans belonging to the authenticated user.

Query Parameters

page integer*

per_page integer*

Responses

200 Instalment plans retrieved successfully

Instalment plans retrieved successfully

status integer

total_results integer

Total number of instalment plans matching the query

instalment_plans array of InstalmentPlan

id string

Unique identifier of the instalment plan

object string

Object type identifier

label string

Display name for the instalment plan

interval integer

Number of cycle units between payments

billing_cycle string

Time unit for payment intervals

dayweekmonthyear

upfront number

Percentage of total amount to pay upfront

interest number

Interest rate percentage applied to instalments

instalments integer

Total number of instalment payments

countries array of string

Array of country codes where this plan is available

sales integer

Number of sales associated with this plan

active boolean

Whether the instalment plan is active

created_at integer

Unix timestamp of when the plan was created

400 Bad request – validation or business-logic error

401 Missing or invalid API key

Create an instalment plan

/instalments/list

1 const response = await fetch("https://api.tamio.com/v2/instalments/list", {
2   headers: {
3     "Authorization": "Bearer YOUR_API_KEY",
4     "Accept": "application/json"
5   }
6 });
7 const data = await response.json();

1 require "uri"
2 require "net/http"
3 
4 url = URI("https://api.tamio.com/v2/instalments/list")
5 
6 https = Net::HTTP.new(url.host, url.port)
7 https.use_ssl = true
8 
9 request = Net::HTTP::Get.new(url)
10 request["Accept"] = "application/json"
11 request["Authorization"] = "Bearer YOUR_API_KEY"
12 
13 response = https.request(request)
14 puts response.read_body

Responses

{
  "status": 200,
  "total_results": 5,
  "instalment_plans": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "object": "instalment_plan",
      "label": "Monthly 3x Plan",
      "interval": 1,
      "billing_cycle": "month",
      "upfront": 10,
      "interest": 5,
      "instalments": 3,
      "countries": [
        "de",
        "fr",
        "us"
      ],
      "sales": 15,
      "active": true,
      "created_at": 1700000000
    }
  ]
}

1	const response = await fetch("https://api.tamio.com/v2/instalments/list", {
2	headers: {
3	"Authorization": "Bearer YOUR_API_KEY",
4	"Accept": "application/json"
5	}
6	});
7	const data = await response.json();

1	require "uri"
2	require "net/http"
3
4	url = URI("https://api.tamio.com/v2/instalments/list")
5
6	https = Net::HTTP.new(url.host, url.port)
7	https.use_ssl = true
8
9	request = Net::HTTP::Get.new(url)
10	request["Accept"] = "application/json"
11	request["Authorization"] = "Bearer YOUR_API_KEY"
12
13	response = https.request(request)
14	puts response.read_body