Get an invoice

1min
GET
https://app.amberflo.io/payments/billing/customer-product-invoice
Use this endpoint to get a specific invoice of a customer.
You can get either the "latest" invoice, by setting the latest parameter to true, or a "previus" invoice by, providing the product plan id and the invoice start date parameters.
To know whether the invoice has been paid or not, look at the paymentStatus of the response.
Authentication
X-API-KEY
apiKey
Query Parameters
customerId
string
*
productId
string
*
fromCache
boolean
withPaymentStatus
boolean
latest
boolean
productPlanId
string
year
integer
month
integer
day
integer
Responses
200
Successful response
billing-customer-product-invoice-response
appliedCommitments
object[]
appliedInvoiceBasedFees
object[]
appliedPromotions
object[]
availablePayAsYouGoMoney
number
availablePayAsYouGoMoneyInBaseCurrency
number
availablePayAsYouGoMoneyInCredits
number
availablePrepaidLeft
number
availablePrepaidLeftBaseCurrency
number
availablePrepaidLeftInCredits
number
creditUnit
object
externalSystemStatus
string
gracePeriodInHours
integer
invoiceBillInBaseCurrency
object
invoiceBillInCredits
object
invoiceEndTimeInSeconds
integer
invoiceKey
object
invoicePriceStatus
string
invoiceStartTimeInSeconds
integer
invoiceUri
string
paymentCreatedInSeconds
integer
paymentCurrencyInfo
object
paymentStatus
string<PRE_PAYMENT | REQUIRES_ACTION | PENDING | FAILED | SETTLED | NOT_NEEDED | UNKNOWN>
planBillingPeriod
object
planName
string
productItemInvoices
object[]
productPlanFees
object[]
totalBill
object
﻿
﻿
Updated 30 Sep 2024
Did this page help you?
List entire history of product plans of a customer
List all invoices