Pause payment collection

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

Temporarily suspends payment collection on a subscription. Choose how pending invoices are handled and optionally schedule an automatic resume date. Only Stripe subscriptions are supported.

Path Parameters

uuid string*

UUID of the subscription to pause.

Body Parameters

pause_behaviour string*

How to handle pending invoices: mark_uncollectible (bad debt), keep_as_draft (retry later), or void (cancel pending payments).

mark_uncollectiblekeep_as_draftvoid

resume_date string

Optional future date to automatically resume payment collection (ISO string or Unix timestamp).

Responses

200 Payment collection paused

Payment collection paused

status integer

subscription Subscription

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`1002`	Subscription not found or not in an active/past_due state
`10256`	A pending subscription update job already exists
`90041`	Payment gateway does not support this operation (only Stripe supported)

status integer

error string

error_code integer

401 Missing or invalid API key

Cancel a subscription

Resume payment collection

/subscriptions/pause/{uuid}

1 const response = await fetch("https://api.tamio.com/v2/subscriptions/pause/{uuid}", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "pause_behaviour": "void",
9     "resume_date": "2025-06-01"
10   })
11 });
12 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/pause/{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   pause_behaviour: "void",
16   resume_date: "2025-06-01"
17 }.to_json
18 
19 response = https.request(request)
20 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": {
      "id": "ccc34567-e89b-12d3-a456-426614174000",
      "name": "John",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "locale": "en",
      "client_id": null,
      "address_id": null
    },
    "imported": false,
    "has_notes": false
  }
}

1	const response = await fetch("https://api.tamio.com/v2/subscriptions/pause/{uuid}", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"pause_behaviour": "void",
9	"resume_date": "2025-06-01"
10	})
11	});
12	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/pause/{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	pause_behaviour: "void",
16	resume_date: "2025-06-01"
17	}.to_json
18
19	response = https.request(request)
20	puts response.read_body