Sign in
Reports

Projected billing report

Projects upcoming rebill and recycle (retry) attempts for active subscriptions in the queried period, using user-supplied approval-rate inputs (rebillProjections and recycleProjections, each a comma-separated list of 4 percentages 0..100 corresponding to Rebill/Recycle #1, #2, #3 and #4+).

get/reports/projected-billing

Query parameters

groupBystring required
Example:billingDate

Field to group results by.

Available fields: billingDate, currency, gatewayProfile, product.name

granularitystring

Date granularity for groupBy when it is a date field. Defaults to day. hour additionally requires the query to be bounded to a createdAt range of at most two days. Accepts hour, day, week, month, quarter, year; anything else falls back to the default.

secondaryGroupBystring

Optional second axis for pivoting (must differ from groupBy). Each row will then carry both the primary groupBy value and a secondaryGroupBy value.

Available fields: billingDate, currency, gatewayProfile, product.name

secondaryGranularitystring

Date granularity for secondaryGroupBy when it is a date field. Defaults to day.

measuresstring
Example:rebillsCount,projectedRevenue,rebillBucket1Count,rebillBucket1BaseAmount,rebillBucket2Count,rebillBucket2BaseAmount,rebillBucket3Count,rebillBucket3BaseAmount,rebillBucketAdditionalCount,rebillBucketAdditionalBaseAmount,recycleBucket1Count,recycleBucket1BaseAmount,recycleBucket2Count,recycleBucket2BaseAmount,recycleBucket3Count,recycleBucket3BaseAmount,recycleBucketAdditionalCount,recycleBucketAdditionalBaseAmount

Metrics to include in the results. Multiple measures can be specified as comma-separated values. If measures is not provided, all metrics specified in the config will be calculated.

Available metrics: rebillsCount, projectedRevenue, rebillBucket1Count, rebillBucket1BaseAmount, rebillBucket2Count, rebillBucket2BaseAmount, rebillBucket3Count, rebillBucket3BaseAmount, rebillBucketAdditionalCount, rebillBucketAdditionalBaseAmount, recycleBucket1Count, recycleBucket1BaseAmount, recycleBucket2Count, recycleBucket2BaseAmount, recycleBucket3Count, recycleBucket3BaseAmount, recycleBucketAdditionalCount, recycleBucketAdditionalBaseAmount

withTotalboolean

Whether to include a rollup row aggregating every group. Pass false to omit it.

eqstring date-time
nestring date-time
gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time
instring[]
ninstring[]
containsstring date-time
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
eqnumber
nenumber
gtnumber
gtenumber
ltnumber
ltenumber
innumber[]
ninnumber[]
containsnumber
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
eqnumber
nenumber
gtnumber
gtenumber
ltnumber
ltenumber
innumber[]
ninnumber[]
containsnumber
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
recycleProjectionsstring
Example:25,15,10,5

Comma-separated list of exactly 4 approval-rate percentages (0..100) for upcoming Recycle #1, #2, #3 and #4+ attempts. Example: 25,15,10,5. Defaults to 0,0,0,0.

rebillProjectionsstring
Example:45,30,20,10

Comma-separated list of exactly 4 approval-rate percentages (0..100) for upcoming Rebill #1, #2, #3 and #4+ attempts. Example: 45,30,20,10. Defaults to 0,0,0,0.

Response

OK

Example response

{
  "data": [
    {
      "groupBy": "usd",
      "secondaryGroupBy": "2026-05-21T00:00:00.000Z",
      "rebillsCount": 128,
      "projectedRevenue": 1834200
    }
  ],
  "total": {
    "groupBy": "usd",
    "secondaryGroupBy": "2026-05-21T00:00:00.000Z",
    "rebillsCount": 128,
    "projectedRevenue": 1834200
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.