Operations API Subscriptions

Cancel a subscription

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

Cancels an active subscription. Choose between immediate termination or graceful end-of-period cancellation.

Path Parameters

uuid string*

UUID of the subscription to cancel.

Body Parameters

cancel_behaviour string*

immediate — instant termination; end_of_period — maintains access until the current billing cycle ends.

immediateend_of_period

Responses

200 Subscription cancelled

Subscription cancelled

status integer

subscription Subscription

400 Validation or business-logic error

401 Missing or invalid API key

Update a subscription plan

Pause payment collection

/subscriptions/cancel/{uuid}

1 const response = await fetch("https://api.tamio.com/v2/subscriptions/cancel/{uuid}", {
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/subscriptions/cancel/{uuid}")
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,
  "subscription": {
    "id": "string",
    "object": "subscription",
    "next_billing_date": 0,
    "cancellation_date": 0,
    "completion_date": 0,
    "resumes_at": 0,
    "products": [],
    "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": "string",
    "price": 0,
    "lifetime_revenue": 0,
    "management_link": "string",
    "instalments_count": 0,
    "customer": {
      "id": "string",
      "name": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "locale": "string",
      "client_id": "string",
      "address_id": "string"
    },
    "imported": false,
    "has_notes": false
  }
}

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