Add a discount

POST https://api.tamio.com/v2/subscriptions/discount/create/{uuid}

Applies a promotional discount to a subscription. The discount can be a fixed amount or a percentage, and can last for one cycle, forever, or a specified number of billing cycles.

Path Parameters

uuid string*

UUID of the subscription.

Body Parameters

duration string*

once — single billing cycle; forever — permanent; repeating — limited number of cycles (requires number_of_months).

onceforeverrepeating

amount integer*

Fixed discount in smallest currency unit (e.g. cents). At least one of amount or percent must be > 0.

percent number*

Percentage discount (0–100). At least one of amount or percent must be > 0.

number_of_months integer

Number of billing cycles the discount lasts (required when duration is repeating, minimum 1).

Responses

200 Discount applied

Discount applied

status integer

subscription Subscription

upcoming_invoice object

Preview of the next invoice after the change.

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`1002`	Subscription not found or not in an active/trialing/past_due state
`10256`	A pending subscription update job already exists

status integer

error string

error_code integer

401 Missing or invalid API key

End a trial period

Remove a discount

/subscriptions/discount/create/{uuid}

1 const response = await fetch("https://api.tamio.com/v2/subscriptions/discount/create/{uuid}", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "duration": "repeating",
9     "amount": 500,
10     "percent": 0,
11     "number_of_months": 3
12   })
13 });
14 const data = await response.json();

1 require "uri"
2 require "net/http"
3 require "json"
4 
5 url = URI("https://api.tamio.com/v2/subscriptions/discount/create/{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   duration: "repeating",
16   amount: 500,
17   percent: 0,
18   number_of_months: 3
19 }.to_json
20 
21 response = https.request(request)
22 puts response.read_body

Responses

{
  "status": 200,
  "subscription": {
    "id": "999e4567-e89b-12d3-a456-426614174000",
    "object": "subscription",
    "next_billing_date": 1735689600,
    "cancellation_date": null,
    "completion_date": null,
    "resumes_at": null,
    "products": [
      {
        "id": "bbb24567-e89b-12d3-a456-426614174000",
        "name": "Pro Plan"
      }
    ],
    "payment_count": 12,
    "status": "active",
    "has_discount": false,
    "gateway_subscription_id": "sub_1PaBcDeFgHiJkLmN",
    "type": "subscription",
    "gateway": "stripe",
    "billing_cycle": "month",
    "interval": 1,
    "currency": "EUR",
    "invoice_id": "aaa14567-e89b-12d3-a456-426614174000",
    "price": 2990,
    "lifetime_revenue": 35880,
    "management_link": "https://billing.example.com",
    "instalments_count": 0,
    "customer": "...",
    "imported": false,
    "has_notes": false
  },
  "upcoming_invoice": {}
}

1	const response = await fetch("https://api.tamio.com/v2/subscriptions/discount/create/{uuid}", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"duration": "repeating",
9	"amount": 500,
10	"percent": 0,
11	"number_of_months": 3
12	})
13	});
14	const data = await response.json();

1	require "uri"
2	require "net/http"
3	require "json"
4
5	url = URI("https://api.tamio.com/v2/subscriptions/discount/create/{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	duration: "repeating",
16	amount: 500,
17	percent: 0,
18	number_of_months: 3
19	}.to_json
20
21	response = https.request(request)
22	puts response.read_body