Update a recurring invoice

POST https://api.tamio.com/v2/orders/recurring/update/{uuid}

Updates an existing recurring invoice subscription with new billing cycles, products, customer details, and subscription settings.

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

Path Parameters

uuid string*

UUID of the recurring invoice subscription to update

Body Parameters

customer object*

Customer information for the recurring subscription

JSON

{ "customer": { "id": "123e4567-e89b-12d3-a456-426614174000", "billing_address_id": "223e4567-e89b-12d3-a456-426614174001", "shipping_address_id": "323e4567-e89b-12d3-a456-426614174002" } }

id string*

Customer UUID

billing_address_id string

Billing address UUID (uses default if omitted)

shipping_address_id string

Shipping address UUID (uses default if omitted)

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

Tax calculation method

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)

products array of object*

Single product for recurring billing

JSON

{ "products": [ { "name": "Premium Plan", "price": 4900, "quantity": 1 } ] }

name string*

Product/service name

price integer*

Price per unit per billing cycle in smallest currency unit

quantity integer

Quantity to bill each cycle

Responses

200 Recurring invoice updated successfully

Recurring invoice updated successfully

status integer

transaction object

Updated transaction object

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`1002`	Recurring invoice not found or belongs to another account

status integer

error string

Human-readable error message

error_code integer

Machine-readable error code

401 Missing or invalid API key

Update a one-time invoice

Delete an order

/orders/recurring/update/{uuid}

1 const response = await fetch("https://api.tamio.com/v2/orders/recurring/update/{uuid}", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "customer": {
9       "id": "123e4567-e89b-12d3-a456-426614174000",
10       "billing_address_id": "223e4567-e89b-12d3-a456-426614174001",
11       "shipping_address_id": "323e4567-e89b-12d3-a456-426614174002"
12     },
13     "date": "2024-01-01T00:00:00Z",
14     "due_date": "2024-01-05T00:00:00Z",
15     "label": "Monthly Subscription",
16     "locale": "en",
17     "currency": "USD",
18     "recurring": true,
19     "taxes": "account",
20     "statement_descriptor": "Company Services",
21     "send_to_customer": true,
22     "trial_period": 14,
23     "billing_cycle": "month",
24     "interval": 1,
25     "payments": [
26       "stripe_123"
27     ],
28     "products": [
29       {
30         "name": "Premium Plan",
31         "price": 4900,
32         "quantity": 1
33       }
34     ]
35   })
36 });
37 const data = await response.json();

1 require "uri"
2 require "net/http"
3 require "json"
4 
5 url = URI("https://api.tamio.com/v2/orders/recurring/update/{uuid}")
6 
7 https = Net::HTTP.new(url.host, url.port)
8 https.use_ssl = true
9 
10 request = Net::HTTP::Post.new(url)
11 request["Accept"] = "application/json"
12 request["Authorization"] = "Bearer YOUR_API_KEY"
13 request["Content-Type"] = "application/json"
14 request.body = {
15   customer: {
16     id: "123e4567-e89b-12d3-a456-426614174000",
17     billing_address_id: "223e4567-e89b-12d3-a456-426614174001",
18     shipping_address_id: "323e4567-e89b-12d3-a456-426614174002"
19   },
20   date: "2024-01-01T00:00:00Z",
21   due_date: "2024-01-05T00:00:00Z",
22   label: "Monthly Subscription",
23   locale: "en",
24   currency: "USD",
25   recurring: true,
26   taxes: "account",
27   statement_descriptor: "Company Services",
28   send_to_customer: true,
29   trial_period: 14,
30   billing_cycle: "month",
31   interval: 1,
32   payments: ["stripe_123"],
33   products: [
34     {
35       name: "Premium Plan",
36       price: 4900,
37       quantity: 1
38     }
39   ]
40 }.to_json
41 
42 response = https.request(request)
43 puts response.read_body

Responses

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

1	const response = await fetch("https://api.tamio.com/v2/orders/recurring/update/{uuid}", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"customer": {
9	"id": "123e4567-e89b-12d3-a456-426614174000",
10	"billing_address_id": "223e4567-e89b-12d3-a456-426614174001",
11	"shipping_address_id": "323e4567-e89b-12d3-a456-426614174002"
12	},
13	"date": "2024-01-01T00:00:00Z",
14	"due_date": "2024-01-05T00:00:00Z",
15	"label": "Monthly Subscription",
16	"locale": "en",
17	"currency": "USD",
18	"recurring": true,
19	"taxes": "account",
20	"statement_descriptor": "Company Services",
21	"send_to_customer": true,
22	"trial_period": 14,
23	"billing_cycle": "month",
24	"interval": 1,
25	"payments": [
26	"stripe_123"
27	],
28	"products": [
29	{
30	"name": "Premium Plan",
31	"price": 4900,
32	"quantity": 1
33	}
34	]
35	})
36	});
37	const data = await response.json();

1	require "uri"
2	require "net/http"
3	require "json"
4
5	url = URI("https://api.tamio.com/v2/orders/recurring/update/{uuid}")
6
7	https = Net::HTTP.new(url.host, url.port)
8	https.use_ssl = true
9
10	request = Net::HTTP::Post.new(url)
11	request["Accept"] = "application/json"
12	request["Authorization"] = "Bearer YOUR_API_KEY"
13	request["Content-Type"] = "application/json"
14	request.body = {
15	customer: {
16	id: "123e4567-e89b-12d3-a456-426614174000",
17	billing_address_id: "223e4567-e89b-12d3-a456-426614174001",
18	shipping_address_id: "323e4567-e89b-12d3-a456-426614174002"
19	},
20	date: "2024-01-01T00:00:00Z",
21	due_date: "2024-01-05T00:00:00Z",
22	label: "Monthly Subscription",
23	locale: "en",
24	currency: "USD",
25	recurring: true,
26	taxes: "account",
27	statement_descriptor: "Company Services",
28	send_to_customer: true,
29	trial_period: 14,
30	billing_cycle: "month",
31	interval: 1,
32	payments: ["stripe_123"],
33	products: [
34	{
35	name: "Premium Plan",
36	price: 4900,
37	quantity: 1
38	}
39	]
40	}.to_json
41
42	response = https.request(request)
43	puts response.read_body