analytics_subscription_billing

Subscription Billing one day's renewals, each with its risk band

Returns one page of a single day’s renewals for the day drawer.

A day has two kinds of row and a subscription can be either: one still scheduled to bill on the date, or one whose charge already ran. Today has both. A renewal that qualifies as both — billed early and already scheduled again — is reported as settled, because an outcome that exists outranks a grade that predicts one.

The scheduled half repeats the billing pipeline’s own eligibility gates, so a renewal automatic billing will never claim is not listed as one the operator can expect to collect. The settled half applies none of them: what ran, ran.

Every row carries the risk band Analytics::RenewalRiskBands gave it — the same classifier behind the month grid’s at-risk figures. The band is served rather than left to the caller precisely so a client cannot keep a second copy of those rules and drift from the cell that opened the drawer.

GET

api

v202604

analytics

subscription_billing

day

Subscription Billing one day's renewals, each with its risk band

curl --request GET \
  --url https://api.fluid.app/api/v202604/analytics/subscription_billing/day \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202604/analytics/subscription_billing/day"

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

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

print(response.text)

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

fetch('https://api.fluid.app/api/v202604/analytics/subscription_billing/day', 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/v202604/analytics/subscription_billing/day",
  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://api.fluid.app/api/v202604/analytics/subscription_billing/day"

	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://api.fluid.app/api/v202604/analytics/subscription_billing/day")

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

{
  "date": "2023-12-25",
  "time_zone": "America/Denver",
  "currency": "USD",
  "page": 123,
  "per_page": 123,
  "total_count": 123,
  "summary": {
    "renewal_count": 123,
    "average_amount": "238.0",
    "new_customer_count": 123,
    "returning_customer_count": 123,
    "top_products": [
      {
        "variant_id": 123,
        "name": "<string>",
        "count": 123,
        "amount": "476.0"
      }
    ]
  },
  "entries": [
    {
      "subscription_id": 123,
      "subscription_token": "<string>",
      "customer_name": "<string>",
      "customer_email": "<string>",
      "variant_name": "<string>",
      "quantity": 123,
      "amount": "8.92",
      "currency": "USD",
      "status": "active",
      "occurred_at": "2023-11-07T05:31:56Z",
      "settled": true,
      "outcome": "succeeded",
      "decline_reason": "<string>",
      "risk_level": "none",
      "risk_factors": [
        "disabled"
      ],
      "awaiting_retry": true
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Requires a company-admin token whose role holds reports.view.

Query Parameters

date

string

required

Calendar date to list, as YYYY-MM-DD. Required and not defaulted: the drawer is always opened from a day the operator picked, so a missing date would answer for a different day than the one on screen. A value that is not this exact shape, or one that names a date which does not exist, returns 400 rather than being coerced.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-09-17"

country

string

ISO alpha-2 code of one of the requesting company's configured countries (see GET /countries). When present, every service on this endpoint filters its data to that country and reports money in the country's own currency. Omit (or send "all") for the aggregate-across-countries view, which is the default and matches pre-Phase-004 behavior. Unknown ISO codes or ones the company is not configured for return 400.

Example:

"US"

string

IANA timezone name (e.g. America/Denver) or Rails-style alias (Eastern Time (US & Canada)) used to anchor "today" boundaries and hour-of-day bucketing. The frontend sends Intl.DateTimeFormat().resolvedOptions().timeZone. Unknown or malformed values silently fall back to UTC — callers omit the param when the endpoint doesn't need wall-clock alignment (see CURRENT-3077).

Example:

"America/Denver"

page

integer

1-based page number. Defaults to 1. Values below 1 are read as 1.

Required range: x >= 1

Example:

1

per_page

integer

Renewals per page. Defaults to 25 and is capped server-side at 100 — a day drawer is a working list rather than an export, and the band lookup costs one extra query per page whatever its size.

A larger value is clamped to the cap rather than rejected, so the cap is deliberately not declared as a schema maximum: doing so would publish a constraint the endpoint does not enforce. Read per_page off the response for the size actually applied.

Required range: x >= 1

Example:

25

Response

One page of the day's renewals

date

string<date>

required

The date the roster covers.

time_zone

string

required

Zone the scheduled half was bucketed in, echoed back so the drawer can label itself. The settled half ignores it: billing events carry an already-local date.

Example:

"America/Denver"

currency

string

required

ISO code every amount on the response is quoted in.

Example:

"USD"

page

integer

required

1-based page number this payload represents.

per_page

integer

required

Page size actually applied, after clamping.

total_count

integer

required

Renewals on the day across every page.

summary

object

required

The day as a whole, independent of which page was requested — computed over the day's full scope, so paging never changes what these figures describe.

Two figures the prototype's day panel showed are absent rather than estimated. A count of scheduled smart retries has no source: billing events carry no retry marker, and the only real fact is whether a retry is scheduled right now, which is per renewal. New against returning is split per customer and not per renewal, so it does not sum to renewal_count.

Show child attributes

entries

object[]

required

Show child attributes

Subscription Billing one day's renewals, each with its risk band

curl --request GET \
  --url https://api.fluid.app/api/v202604/analytics/subscription_billing/day \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202604/analytics/subscription_billing/day"

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

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

print(response.text)

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

fetch('https://api.fluid.app/api/v202604/analytics/subscription_billing/day', 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/v202604/analytics/subscription_billing/day",
  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://api.fluid.app/api/v202604/analytics/subscription_billing/day"

	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://api.fluid.app/api/v202604/analytics/subscription_billing/day")

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

{
  "date": "2023-12-25",
  "time_zone": "America/Denver",
  "currency": "USD",
  "page": 123,
  "per_page": 123,
  "total_count": 123,
  "summary": {
    "renewal_count": 123,
    "average_amount": "238.0",
    "new_customer_count": 123,
    "returning_customer_count": 123,
    "top_products": [
      {
        "variant_id": 123,
        "name": "<string>",
        "count": 123,
        "amount": "476.0"
      }
    ]
  },
  "entries": [
    {
      "subscription_id": 123,
      "subscription_token": "<string>",
      "customer_name": "<string>",
      "customer_email": "<string>",
      "variant_name": "<string>",
      "quantity": 123,
      "amount": "8.92",
      "currency": "USD",
      "status": "active",
      "occurred_at": "2023-11-07T05:31:56Z",
      "settled": true,
      "outcome": "succeeded",
      "decline_reason": "<string>",
      "risk_level": "none",
      "risk_factors": [
        "disabled"
      ],
      "awaiting_retry": true
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

Overview

Task guides

Portal & Widgets

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Member endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Analytics

Subscription Billing one day's renewals, each with its risk band

Authorizations

Query Parameters

Response