Create a recurring invoice

POST https://api.tamio.com/v2/orders/recurring/create

Creates a recurring subscription invoice with flexible billing cycles, trial periods, and automated payment collection. Supports weekly, monthly, yearly, and daily intervals.

The interval field maximum depends on the billing_cycle value:

day → max interval 365
week → max interval 52
month → max interval 12
year → max interval 1

Body Parameters

customer object*

date object*

Subscription start date (ISO format or Unix timestamp)

due_date object

Payment due date for each generated invoice

label string

Invoice label/title

locale string

Language code for localization

currency string*

Three-letter ISO currency code

recurring boolean*

Must be true for recurring invoices

taxes string

accountoff

statement_descriptor string

Text on customer's bank/card statement

send_to_customer boolean

Send each invoice to customer via email

trial_period integer

Trial period in days before first charge

billing_cycle string*

Billing frequency unit

dayweekmonthyear

interval integer*

Number of billing_cycle units between charges

payments array of string*

Payment method IDs (required for recurring)

appendix string

Additional text/notes appended to each invoice

fulfillment_options FulfillmentOptions

products array of object*

Single product for recurring billing

Responses

200 Recurring invoice created successfully

Recurring invoice created successfully

status integer

transaction object

Transaction object with subscription details

400 Bad request – validation or business-logic error

401 Missing or invalid API key

Create an invoice

Update a one-time invoice

/orders/recurring/create

1 const response = await fetch("https://api.tamio.com/v2/orders/recurring/create", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     // ... request body
9   })
10 });
11 const data = await response.json();

1 require "uri"
2 require "net/http"
3 
4 url = URI("https://api.tamio.com/v2/orders/recurring/create")
5 
6 https = Net::HTTP.new(url.host, url.port)
7 https.use_ssl = true
8 
9 request = Net::HTTP::Post.new(url)
10 request["Accept"] = "application/json"
11 request["Authorization"] = "Bearer YOUR_API_KEY"
12 request["Content-Type"] = "application/json"
13 request.body = %Q{
14   // ... request body
15 }
16 
17 response = https.request(request)
18 puts response.read_body

Responses

{
  "status": 200,
  "transaction": {}
}

1	const response = await fetch("https://api.tamio.com/v2/orders/recurring/create", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	// ... request body
9	})
10	});
11	const data = await response.json();

1	require "uri"
2	require "net/http"
3
4	url = URI("https://api.tamio.com/v2/orders/recurring/create")
5
6	https = Net::HTTP.new(url.host, url.port)
7	https.use_ssl = true
8
9	request = Net::HTTP::Post.new(url)
10	request["Accept"] = "application/json"
11	request["Authorization"] = "Bearer YOUR_API_KEY"
12	request["Content-Type"] = "application/json"
13	request.body = %Q{
14	// ... request body
15	}
16
17	response = https.request(request)
18	puts response.read_body