Retrieve customer product invoice

1 min

GET

https://app.amberflo.io/payments/billing/customer-product-invoice

Retrieves a specific customer invoice with detailed usage and billing information. Use this endpoint to access current or historical invoice data for billing analysis and payment tracking.

Use this endpoint to:

Get the latest invoice by setting latest=true
Retrieve historical invoices using product plan ID and start date
Check payment status via the paymentStatus field
Access detailed usage breakdown and charges

customerIdstringUnique identifier of the customer whose invoice you want to retrieve

productIdstringProduct ID to filter invoices by. Defaults to "1" if not specified

latestbooleanSet to true to retrieve the latest invoice for the customer and product

fromCachebooleanSet to false to fetch fresh usage data and enrich invoice with real-time information

withPaymentStatusbooleanInclude payment status information in the response

withHourlyBillbooleanInclude hourly billing breakdown in the invoice details

startTimeInSecondsinteger<int64>Unix timestamp in seconds for invoice period start time (for historical invoice lookup)

endTimeInSecondsinteger<int64>Unix timestamp in seconds for invoice period end time (for historical invoice lookup)

invoiceStatusstringFilter invoices by their current status

200Returns detailed customer invoice information including usage charges and payment status

400Invalid parameters or conflicting query options provided

401Authentication required or invalid API key provided

403Insufficient permissions to access customer invoice data

404Customer or invoice not found for the specified criteria

500Internal server error occurred while retrieving invoice data

curl --request GET \
     --url 'https://app.amberflo.io/payments/billing/customer-product-invoice?customerId=customer_123&productId=1&latest=true&fromCache=boolean&withPaymentStatus=true&withHourlyBill=boolean' \
     --header 'accept: application/json'