---
title: "Projected billing report"
method: GET
path: "/reports/projected-billing"
tags: ["Reports"]
---

# Projected billing report

`GET /reports/projected-billing`

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+).

## Query parameters

- `groupBy` string, required
- `granularity` string
- `secondaryGroupBy` string
- `secondaryGranularity` string
- `measures` string
- `withTotal` boolean
- `billingDate` object
  - `eq` string, date-time
  - `ne` string, date-time
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
  - `in` string[]
  - `nin` string[]
  - `contains` string, date-time
- `currency` object
  - `eq` string
  - `ne` string
  - `like` string
  - `in` string[]
  - `nin` string[]
  - `contains` string
- `gatewayProfile` object
  - `eq` string
  - `ne` string
  - `like` string
  - `in` string[]
  - `nin` string[]
  - `contains` string
- `dueAmount` object
  - `eq` number
  - `ne` number
  - `gt` number
  - `gte` number
  - `lt` number
  - `lte` number
  - `in` number[]
  - `nin` number[]
  - `contains` number
- `attemptType` object
  - `eq` string
  - `ne` string
  - `like` string
  - `in` string[]
  - `nin` string[]
  - `contains` string
- `attemptBucket` object
  - `eq` number
  - `ne` number
  - `gt` number
  - `gte` number
  - `lt` number
  - `lte` number
  - `in` number[]
  - `nin` number[]
  - `contains` number
- `price` object
  - `eq` string
  - `ne` string
  - `like` string
  - `in` string[]
  - `nin` string[]
  - `contains` string
- `product` object
  - `eq` string
  - `ne` string
  - `like` string
  - `in` string[]
  - `nin` string[]
  - `contains` string
- `recycleProjections` string
- `rebillProjections` string

## Response `200`

OK

- ProjectedBillingReportResponseDTO
  - `data` object[], required
    - `groupBy` string, nullable — The value of the groupBy field (field name varies based on groupBy parameter)
    - `secondaryGroupBy` string, nullable — The value of the secondaryGroupBy field (present only when secondaryGroupBy was supplied)
    - `rebillsCount` number — Total number of upcoming rebill + recycle attempts in the bucket
    - `projectedRevenue` number — Projected revenue across all upcoming attempts, in the merchant display currency's minor units (integer). Both rebills and recycles apply the per-attempt approval rate directly.
    - `rebillBucket1Count` number — Number of upcoming Rebill #1 attempts
    - `rebillBucket1BaseAmount` number — Total invoice amount of upcoming Rebill #1 attempts
    - `rebillBucket2Count` number — Number of upcoming Rebill #2 attempts
    - `rebillBucket2BaseAmount` number — Total invoice amount of upcoming Rebill #2 attempts
    - `rebillBucket3Count` number — Number of upcoming Rebill #3 attempts
    - `rebillBucket3BaseAmount` number — Total invoice amount of upcoming Rebill #3 attempts
    - `rebillBucketAdditionalCount` number — Number of upcoming Rebill #4+ (additional) attempts
    - `rebillBucketAdditionalBaseAmount` number — Total invoice amount of upcoming Rebill #4+ (additional) attempts
    - `recycleBucket1Count` number — Number of upcoming Recycle #1 attempts
    - `recycleBucket1BaseAmount` number — Total invoice amount of upcoming Recycle #1 attempts
    - `recycleBucket2Count` number — Number of upcoming Recycle #2 attempts
    - `recycleBucket2BaseAmount` number — Total invoice amount of upcoming Recycle #2 attempts
    - `recycleBucket3Count` number — Number of upcoming Recycle #3 attempts
    - `recycleBucket3BaseAmount` number — Total invoice amount of upcoming Recycle #3 attempts
    - `recycleBucketAdditionalCount` number — Number of upcoming Recycle #4+ (additional) attempts
    - `recycleBucketAdditionalBaseAmount` number — Total invoice amount of upcoming Recycle #4+ (additional) attempts
  - `total` object
    - `groupBy` string, nullable — The value of the groupBy field (field name varies based on groupBy parameter)
    - `secondaryGroupBy` string, nullable — The value of the secondaryGroupBy field (present only when secondaryGroupBy was supplied)
    - `rebillsCount` number — Total number of upcoming rebill + recycle attempts in the bucket
    - `projectedRevenue` number — Projected revenue across all upcoming attempts, in the merchant display currency's minor units (integer). Both rebills and recycles apply the per-attempt approval rate directly.
    - `rebillBucket1Count` number — Number of upcoming Rebill #1 attempts
    - `rebillBucket1BaseAmount` number — Total invoice amount of upcoming Rebill #1 attempts
    - `rebillBucket2Count` number — Number of upcoming Rebill #2 attempts
    - `rebillBucket2BaseAmount` number — Total invoice amount of upcoming Rebill #2 attempts
    - `rebillBucket3Count` number — Number of upcoming Rebill #3 attempts
    - `rebillBucket3BaseAmount` number — Total invoice amount of upcoming Rebill #3 attempts
    - `rebillBucketAdditionalCount` number — Number of upcoming Rebill #4+ (additional) attempts
    - `rebillBucketAdditionalBaseAmount` number — Total invoice amount of upcoming Rebill #4+ (additional) attempts
    - `recycleBucket1Count` number — Number of upcoming Recycle #1 attempts
    - `recycleBucket1BaseAmount` number — Total invoice amount of upcoming Recycle #1 attempts
    - `recycleBucket2Count` number — Number of upcoming Recycle #2 attempts
    - `recycleBucket2BaseAmount` number — Total invoice amount of upcoming Recycle #2 attempts
    - `recycleBucket3Count` number — Number of upcoming Recycle #3 attempts
    - `recycleBucket3BaseAmount` number — Total invoice amount of upcoming Recycle #3 attempts
    - `recycleBucketAdditionalCount` number — Number of upcoming Recycle #4+ (additional) attempts
    - `recycleBucketAdditionalBaseAmount` number — Total invoice amount of upcoming Recycle #4+ (additional) attempts

## Other responses

- `202` — The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.
- `400` — The request was rejected. `type` is `invalid_request_error` when the request itself is at fault — `errors` then lists every problem found, with field-attributable entries prefixed by the field’s path; `invalid_state_error` when the request was well-formed but the resource is not in a state that allows it; or `payment_error` when the payment was refused by the issuer or processor.
- `401` — No API key was supplied, or the key is not valid. `type` is `authentication_error`.
- `403` — The API key is valid but lacks the permission this operation requires. `type` is `permission_error`.
- `429` — Too many requests. The rate limit is applied per client across all operations. `type` is `rate_limit_error`.
- `500` — The request could not be completed because of an unexpected error. `type` is `api_error`.
- `504` — The request exceeded the processing time limit and was abandoned. `type` is `api_error` and `code` is `timeout` — unlike a plain 500 the request may still have taken effect, so retry with the same idempotency key rather than blindly.

---

[API](https://skmtc.dev/odus/apis/odus-orchestration-api.md) · [All operations](https://skmtc.dev/odus/apis/odus-orchestration-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/odus/odus-orchestration-api/revisions/d5fdcba31576/schema)