List all subscriptions

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

Returns a paginated list of subscriptions. Supports filtering by customer, product, instalment plan, billing cycle, currency, status flags (cancelled, completed, paused, instalments), date range, and free-text search.

Query Parameters

page integer*

Page number for pagination.

per_page integer*

Number of subscriptions per page.

order string

Sort direction.

ascdesc

sort_by string

Field to sort by.

emailnext_billing_datestatusdatecancelledpayment_count

filter string

Free-text search across subscription data.

from string

Start date filter (ISO string or Unix timestamp).

to string

End date filter (ISO string or Unix timestamp).

customer_id string

Filter by customer UUID.

product_id string

Filter by product UUID.

instalment_plan_id string

Filter by instalment plan UUID.

cancelled boolean

Show only cancelled subscriptions.

completed boolean

Show only completed subscriptions.

exclude_paused boolean

Exclude paused subscriptions from results.

instalments boolean

Show only instalment-based subscriptions.

billing_cycle string

Filter by billing frequency.

dayweekmonthyear

currency string

Filter by ISO currency code.

Responses

200 Paginated list of subscriptions

Paginated list of subscriptions

status integer

total_results integer

subscriptions array of Subscription

400 Validation or business-logic error

401 Missing or invalid API key

Retrieve a subscription

/subscriptions/list

1 const response = await fetch("https://api.tamio.com/v2/subscriptions/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/subscriptions/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": 85,
  "subscriptions": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "object": "subscription",
      "next_billing_date": 0,
      "cancellation_date": 0,
      "completion_date": 0,
      "resumes_at": 0,
      "products": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "string"
        }
      ],
      "payment_count": 0,
      "status": "string",
      "has_discount": false,
      "gateway_subscription_id": "string",
      "type": "subscription",
      "gateway": "string",
      "billing_cycle": "string",
      "interval": 0,
      "currency": "string",
      "invoice_id": "00000000-0000-0000-0000-000000000000",
      "price": 0,
      "lifetime_revenue": 0,
      "management_link": "string",
      "instalments_count": 0,
      "customer": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "locale": "string",
        "client_id": "string",
        "address_id": "00000000-0000-0000-0000-000000000000"
      },
      "imported": false,
      "has_notes": false
    }
  ]
}

1	const response = await fetch("https://api.tamio.com/v2/subscriptions/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/subscriptions/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