Skip to main content
Charge & Refund reporting is available as part of Digital Vending Machine’s optional Billing & Charging capability. Contact us to find out more about Billing and Charging.
When you use the Charges and Refunds APIs, every billing event we process on your behalf is recorded. Each month you receive a structured record of every charge and refund we have processed for your consumers: what was billed, when, for which product, and whether it succeeded. You can use them to:
  • Reconcile revenue against your own systems, using your own reference numbers
  • Match refunds to the charges they reverse, without stitching API calls together
  • Understand billing patterns across your consumer base: first bills versus renewals, promotional pricing versus full price

The two reports

Both cover charges and refunds.

Charge Detail Report

The most granular view. One row per line item means a bundle charge covering three content providers produces three rows, each carrying the shared transaction details plus its own amount. By default the report contains successful charges and refunds.

Field reference

Identifying your consumer Identifying the transaction When it happened What kind of transaction it was What was billed for How much

Charge Summary Reports

An aggregated monthly view for reporting and trend analysis rather than line-by-line reconciliation. An example of the report:

Reading the reports

Amounts are in standard currency units. A charge of nineteen dollars ninety-nine appears as 19.99. Always read amount together with currency. Retries share a billId. If a renewal charge fails and is retried, each attempt is a separate row with the same billId and an incrementing attempt value. To count billing events rather than billing attempts, group by billId. Line items repeat the transaction details. In the Detail Report, header information such as transactionId and billEffectiveDate is repeated on each line item row. De-duplicate on transactionId if you need one row per transaction.

Billing plan report

Report format for billing plans managed during a reporting period.

Forecast report

Report format for future invoices due in the next month.