settings-v0
Preview what a blackout calendar would move
Counts the subscriptions the daily sweep would move now under the proposed blackout rules, so a merchant sees the effect before it saves them. A subscription counts when it is on a month or year plan, is active, or paused with a bill date, is not claimed by a renewal, and its local bill date is on a blocked day after the reminder window. The window is the merchant’s reminder_lead_days, but at least 3 days. The blackout_dates feature need not be on, so a merchant can preview before it turns the feature on. Not found (404, subscription_pro_inactive) while Subscription Pro is not active, which fluid-admin reads as no count to show. Nothing is saved and no sweep is queued. Responses are not cached.
POST
/
api
/
subscription_pro
/
blackout_preview
Preview what a blackout calendar would move
curl --request POST \
--url https://api.fluid.app/api/subscription_pro/blackout_preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"blackout_rules": [
{
"name": "Month end",
"blocked_days": [
29,
30,
31
],
"move_to_day": 28
}
]
}
'import requests
url = "https://api.fluid.app/api/subscription_pro/blackout_preview"
payload = { "blackout_rules": [
{
"name": "Month end",
"blocked_days": [29, 30, 31],
"move_to_day": 28
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
blackout_rules: [{name: 'Month end', blocked_days: [29, 30, 31], move_to_day: 28}]
})
};
fetch('https://api.fluid.app/api/subscription_pro/blackout_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://api.fluid.app/api/subscription_pro/blackout_preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'blackout_rules' => [
[
'name' => 'Month end',
'blocked_days' => [
29,
30,
31
],
'move_to_day' => 28
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fluid.app/api/subscription_pro/blackout_preview"
payload := strings.NewReader("{\n \"blackout_rules\": [\n {\n \"name\": \"Month end\",\n \"blocked_days\": [\n 29,\n 30,\n 31\n ],\n \"move_to_day\": 28\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fluid.app/api/subscription_pro/blackout_preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"blackout_rules\": [\n {\n \"name\": \"Month end\",\n \"blocked_days\": [\n 29,\n 30,\n 31\n ],\n \"move_to_day\": 28\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/subscription_pro/blackout_preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"blackout_rules\": [\n {\n \"name\": \"Month end\",\n \"blocked_days\": [\n 29,\n 30,\n 31\n ],\n \"move_to_day\": 28\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"moves": 3,
"by_day": {
"29": {
"to": 28,
"count": 1
},
"30": {
"to": 28,
"count": 2
}
},
"status": 200,
"meta": {
"request_id": "7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42",
"timestamp": "2026-10-25T12:00:00Z"
}
}{
"message": "<string>",
"error": "<string>",
"error_message": "<string>",
"errors": "<string>",
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"error": "<string>",
"error_message": "<string>",
"errors": "<string>",
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "Subscription Pro is not active",
"details": {
"error": "subscription_pro_inactive"
}
},
"status": 404,
"meta": {
"request_id": "7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42",
"timestamp": "2026-10-25T12:00:00Z"
}
}{
"error": {
"message": "Invalid parameters",
"details": {
"blackout_rules": {
"0": {
"move_to_day": [
"is blocked by rule 2"
]
}
}
}
},
"status": 422,
"meta": {
"request_id": "7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42",
"timestamp": "2026-10-25T12:00:00Z"
}
}Authorizations
Bearer token authentication
Body
application/json
The proposed blackout calendar, as it would be saved. An empty list previews no rules and counts no moves. The same checks as a settings save apply: a rule's move_to_day may not be blocked by any rule, including a disabled one; a move_to_day above 28 may not have a blocked day from 28 to the day before it; and a rule may not repeat a day.
Maximum array length:
20Show child attributes
Show child attributes
Response
Success
The counts sit at the top level of the body, beside status and meta, with no wrapper key.
The number of subscriptions the daily sweep would move now under the proposed rules.
Required range:
x >= 0The moves per blocked day. A key is the day of the month, "1" to "31". A blocked day that holds no move is left out.
Show child attributes
Show child attributes
Available options:
200 Show child attributes
Show child attributes
⌘I
Preview what a blackout calendar would move
curl --request POST \
--url https://api.fluid.app/api/subscription_pro/blackout_preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"blackout_rules": [
{
"name": "Month end",
"blocked_days": [
29,
30,
31
],
"move_to_day": 28
}
]
}
'import requests
url = "https://api.fluid.app/api/subscription_pro/blackout_preview"
payload = { "blackout_rules": [
{
"name": "Month end",
"blocked_days": [29, 30, 31],
"move_to_day": 28
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
blackout_rules: [{name: 'Month end', blocked_days: [29, 30, 31], move_to_day: 28}]
})
};
fetch('https://api.fluid.app/api/subscription_pro/blackout_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://api.fluid.app/api/subscription_pro/blackout_preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'blackout_rules' => [
[
'name' => 'Month end',
'blocked_days' => [
29,
30,
31
],
'move_to_day' => 28
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fluid.app/api/subscription_pro/blackout_preview"
payload := strings.NewReader("{\n \"blackout_rules\": [\n {\n \"name\": \"Month end\",\n \"blocked_days\": [\n 29,\n 30,\n 31\n ],\n \"move_to_day\": 28\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fluid.app/api/subscription_pro/blackout_preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"blackout_rules\": [\n {\n \"name\": \"Month end\",\n \"blocked_days\": [\n 29,\n 30,\n 31\n ],\n \"move_to_day\": 28\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/subscription_pro/blackout_preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"blackout_rules\": [\n {\n \"name\": \"Month end\",\n \"blocked_days\": [\n 29,\n 30,\n 31\n ],\n \"move_to_day\": 28\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"moves": 3,
"by_day": {
"29": {
"to": 28,
"count": 1
},
"30": {
"to": 28,
"count": 2
}
},
"status": 200,
"meta": {
"request_id": "7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42",
"timestamp": "2026-10-25T12:00:00Z"
}
}{
"message": "<string>",
"error": "<string>",
"error_message": "<string>",
"errors": "<string>",
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"error": "<string>",
"error_message": "<string>",
"errors": "<string>",
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "Subscription Pro is not active",
"details": {
"error": "subscription_pro_inactive"
}
},
"status": 404,
"meta": {
"request_id": "7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42",
"timestamp": "2026-10-25T12:00:00Z"
}
}{
"error": {
"message": "Invalid parameters",
"details": {
"blackout_rules": {
"0": {
"move_to_day": [
"is blocked by rule 2"
]
}
}
}
},
"status": 422,
"meta": {
"request_id": "7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42",
"timestamp": "2026-10-25T12:00:00Z"
}
}