Billing plan report – COMING SOON
- Billing & charging reports
- Billing plan report
Billing plan report – COMING SOON
This report provides a comprehensive view of all billing plans that were being managed during the reporting period. If you are specifically interested in what was charged during the reporting period, please view the charge report.
This is a detailed report designed to give you all the information you need to link a billing plan to a consumer, offer, or a consumer offer. It also tells you information about the plan phases (current and future) as well as invoice information (previous and next).
A billing plan appears once in the report e.g. if the billing plan went through multiple statuses during the reporting period, or has a renewal frequency shorter than the reporting period, it will still only show as a single row, with the most up to date data from the end of the reporting period.
The report includes:
- All billing plans created during the reporting period
- All billing plans that were active during the reporting period
- All billing plans that were paused during the reporting period
- All billing plans that ended during the reporting period
The report does not include:
- Any billing plan which ended prior to the start of the reporting period
Report format
Column name | Format | Description | Example |
|---|---|---|---|
consumerIdentifier | string | Unique id of your consumer | AC-345/JF7A |
consumerOfferId | uuid | Unique id of the consumer’s bundle | dd8e206a-fb89-4ed1-9115-af38466d6003 |
offerId | uuid | Unique id of the offer associated to the consumer’s bundle | 088bdb2b-742f-4a4a-b0c3-bd0589b49a6c |
offerName | string | The human readable name of the offer | Bango Music Premium – 6 months free |
billingPlanId | uuid | Unique id of the billing plan associated to the consumer’s bundle | 5264c710-52a8-4668-bbfc-12eeeb515f9c |
planType | string enum | Describes the type of offer based on the associated plan information. Supported options: SUBSCRIPTION Future supported options: REDEMPTION FIXED_TERM TRANSACTION | SUBSCRIPTION |
billingTrigger | string enum | The trigger that starts the billing lifecycle. Options are: CONSUMER_OFFER_FULLY_CREATED CONSUMER_OFFER_FULLY_ACTIVATED This list is expected to grow over time | CONSUMER_OFFER_FULLY_ACTIVATED |
billingPlanStatus | string enum | The status of the billing plan at the end of the reporting period. Options are: REQUESTED CREATED ACTIVE PAUSED ENDED | ACTIVE |
billingPlanSubStatus | string enum | The (optional) sub status of the billing plan. These are transient and not always present. They are used to indicate upcoming state changes. Options are: PAUSING (applicable to CREATED and ACTIVE statuses) ENDING (applicable to CREATED, ACTIVE and PAUSED statuses) | |
createdTs | ISO-8601 to milliseconds | The date/time the billing plan was created | 2024-12-21T14:23:21.986Z |
startedTs | ISO-8601 to milliseconds | The date/time the billing plan lifecycle started | 2024-12-22T17:53:21.013Z |
endingTs | ISO-8601 to milliseconds | The date/time the billing plan was flagged as ending | |
endedTs | ISO-8601 to milliseconds | The date/time the billing plan was terminated | |
currentPhase | integer | The phase the billing plan is currently in. 0 is the first phase of the plan. | 0 |
currentPhaseType | string enum | The type of phase. Options are: FREE DISCOUNT FULL_PRICE | FREE |
nextPhaseType | string enum | The next phase’s type. This will not be populated if there is no next phase (e.g. the current phase is evergreen) | FULL_PRICE |
nextPhaseTs | ISO-8601 to milliseconds | The date/time the billing plan moves to the next phase (if applicable) | 2025-06-22T17:53:21.013Z |
currency | IS0-4217 | Alphabetic 3-letter code from the international currency code standard | USD |
lastInvoiceTs | ISO-8601 to milliseconds | The date/time the last invoice was issued | 2025-04-22T17:53:21.013Z |
lastInvoiceId | uuid | Unique id of this invoice | 4096f6f0-121f-4b44-81a5-c5598e67daf3 |
lastInvoiceDisplayAmount | number | The amount invoicable, shown to the max decimals for the currency | 0.00 |
lastInvoiceStatus | string enum | Status options are: ISSUED PAID NOT_PAID REFUNDED RESCINDED There are 2 earlier statuses for INITIALIZED and CALCULATED which are not expected to appear in this report for a historical invoice. | PAID |
lastInvoiceSubStatus | string enum | Optional statuses are: PENDING_CALCULATE (only applicable for INITIALIZED) PARTIALLY_PAID PAYMENT_NOT_REQUIRED (e.g. $0 charge amount suppressed) NO_PAYMENT_METHOD | |
nextInvoiceTs | ISO-8601 to milliseconds | The date/time the next invoice is due | 2025-05-22T17:53:21.013Z |
nextInvoiceId | uuid | Unique id of this invoice | 4096f6f0-121f-4b44-81a5-c5598e67daf3 |
nextInvoiceDisplayAmount | number | The amount invoicable, shown to the max decimals for the currency | 17.99 |
nextInvoiceStatus | string enum | Status options are: CALCULATED While there are other statuses, no others are expected to appear in this column. | CALCULATED |