Cancel Preview

GET

subscriptions

{id}

cancel-preview

Preview the financial consequence of a cancellation

curl --request GET \
  --url https://billing.example.com/v1/subscriptions/{id}/cancel-preview \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://billing.example.com/v1/subscriptions/{id}/cancel-preview"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/subscriptions/{id}/cancel-preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/subscriptions/{id}/cancel-preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/subscriptions/{id}/cancel-preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/subscriptions/{id}/cancel-preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "immediately": true,
    "effective_date": "2023-11-07T05:31:56Z",
    "resulting_status": "<string>",
    "cancel_at_period_end": true,
    "currency": "<string>",
    "deferred_revenue_forfeited": 123,
    "recognized_as_breakage": 123,
    "avoided_future_recurring": 123,
    "flat_fee_refund": 123
  }
}

Returns the deterministic financial forecast of canceling a subscription, shown before the mutation so an operator never cancels blind. The cancel mutation itself is unchanged — this endpoint only reads. It exposes exactly what the engine computes deterministically:

effective_date and resulting_status — when the cancel would take effect and the status it leaves the subscription in.
deferred_revenue_forfeited / recognized_as_breakage — the still-deferred revenue an immediate cancel forfeits and recognizes as breakage, computed read-only from the same revenue-recognition data the mutation uses.
avoided_future_recurring — the future recurring amount that will no longer bill.
flat_fee_refund — always 0: the flat fee is paid in advance and is not refunded.

It deliberately omits an unused-time proration credit (the cancel mutation posts none) and a final metered-usage figure (only the mutating invoice path can produce one). See Explain any number.

Query Parameters

Parameter	Type	Required	Description
`immediately`	boolean	No	Preview an immediate cancel (`true`) vs cancel-at-period-end (default `false`).

Example Request

curl "https://api.recurso.dev/v1/subscriptions/b9071c55-0e14-4720-80f3-665613ceb7de/cancel-preview?immediately=true" \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "data": {
    "subscription_id": "b9071c55-0e14-4720-80f3-665613ceb7de",
    "immediately": true,
    "effective_date": "2026-08-18T10:30:00Z",
    "resulting_status": "canceled",
    "cancel_at_period_end": false,
    "currency": "USD",
    "deferred_revenue_forfeited": 45161,
    "recognized_as_breakage": 45161,
    "avoided_future_recurring": 100000,
    "flat_fee_refund": 0
  }
}

Fields

Field	Type	Description
`immediately`	boolean	The mode that was previewed
`effective_date`	string (date-time)	When the cancel would take effect
`resulting_status`	string	The status the subscription would end up in
`cancel_at_period_end`	boolean	`true` when the preview is a period-end cancel
`currency`	string	Currency of the amounts below
`deferred_revenue_forfeited`	integer (int64)	Still-deferred revenue an immediate cancel forfeits, minor units
`recognized_as_breakage`	integer (int64)	The portion recognized as breakage on cancel
`avoided_future_recurring`	integer (int64)	Future recurring amount that will no longer bill
`flat_fee_refund`	integer (int64)	Always `0` — flat fee paid in advance, not refunded

Read-only and side-effect free — nothing is posted, scheduled, or changed. A missing or cross-tenant id returns 404.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

string<uuid>

required

Query Parameters

immediately

boolean

default:false

Preview an immediate cancel (true) vs cancel-at-period-end (default).

Response

The cancel preview.

data

object

Show child attributes

Preview the financial consequence of a cancellation

curl --request GET \
  --url https://billing.example.com/v1/subscriptions/{id}/cancel-preview \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://billing.example.com/v1/subscriptions/{id}/cancel-preview"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/subscriptions/{id}/cancel-preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/subscriptions/{id}/cancel-preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/subscriptions/{id}/cancel-preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/subscriptions/{id}/cancel-preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "immediately": true,
    "effective_date": "2023-11-07T05:31:56Z",
    "resulting_status": "<string>",
    "cancel_at_period_end": true,
    "currency": "<string>",
    "deferred_revenue_forfeited": 123,
    "recognized_as_breakage": 123,
    "avoided_future_recurring": 123,
    "flat_fee_refund": 123
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Query Parameters

Example Request

Response

Fields

Authorizations

Path Parameters

Query Parameters

Response

​Query Parameters

​Example Request

​Response

​Fields

Authorizations

Path Parameters

Query Parameters

Response

Query Parameters

Example Request

Response

Fields