Get a specific invoice for the customer
1 min
GET
https://app.amberflo.io/customer-portal/invoice
Query Parameters
- productIdstringrequiredDescriptionDefault1
- fromCachebooleanDescription
- withPaymentStatusbooleanDescription
- latestbooleanDescription
- productPlanIdstringDescription
- yearintegerDescription
- monthintegerDescription
- dayintegerDescription
- sessionTokenstringrequiredDescription
Responses
200
- billing-customer-product-invoice-response
- appliedCommitmentsobject[]Description
- commitmentIdstring
- feeAmountnumber
- feeInBaseCurrencynumber
- feeInCreditsnumber
- obligationIdstring
- obligationNamestring
- appliedInvoiceBasedFeesobject[]Description
- feeAmountnumber
- feeIdstring
- feeInBaseCurrencynumber
- feeInCreditsnumber
- feeNamestring
- appliedPromotionsobject[]
- canBeUsedForPayAsYouGoboolean
- dimensionsmap<string, string>
- discountnumber
- discountInBaseCurrencynumber
- discountInCreditsnumber
- entityTdstring
- granularitystring
- maxDiscountInBaseCurrencynumber
- maxDiscountPossiblenumber
- promotionAppliedTimeInSecondsinteger
- promotionIdstring
- promotionNamestring
- promotionTypestringDescription
- availablePayAsYouGoMoneynumberDescription
- availablePayAsYouGoMoneyInBaseCurrencynumber
- availablePayAsYouGoMoneyInCreditsnumber
- availablePrepaidLeftnumberDescription
- availablePrepaidLeftBaseCurrencynumber
- availablePrepaidLeftInCreditsnumber
- creditUnitobject
- activeboolean
- descriptionstring
- idstring
- lastUpdateTimeInMillisinteger
- namestring
- ratioToCurrencynumber
- shortNamestring
- externalSystemStatusstring
- gracePeriodInHoursinteger
- invoiceBillInBaseCurrencyobject
- commitmentsFeesnumber
- discountableBasePricenumber
- discountableFixPricenumber
- endTimeInSecondsinteger
- fixPricenumber
- invoiceBasedFeesnumber
- itemPricenumber
- prepaidnumber
- prepayableCommitmentsFeesnumber
- prepayableFixPricenumber
- prepayableNotDiscountableFeesnumber
- startTimeInSecondsinteger
- totalDiscountnumber
- totalPrepayablePricenumber
- totalPricenumber
- totalPriceBeforeCommitmentsnumber
- totalPriceBeforeDiscountnumber
- totalPriceBeforePrepaidnumber
- invoiceBillInCreditsobject
- commitmentsFeesnumber
- discountableBasePricenumber
- discountableFixPricenumber
- endTimeInSecondsinteger
- fixPricenumber
- invoiceBasedFeesnumber
- itemPricenumber
- prepaidnumber
- prepayableCommitmentsFeesnumber
- prepayableFixPricenumber
- prepayableNotDiscountableFeesnumber
- startTimeInSecondsinteger
- totalDiscountnumber
- totalPrepayablePricenumber
- totalPricenumber
- totalPriceBeforeCommitmentsnumber
- totalPriceBeforeDiscountnumber
- totalPriceBeforePrepaidnumber
- invoiceEndTimeInSecondsinteger
- invoiceKeyobject
- accountIdstring
- customerIdstring
- dayinteger
- monthinteger
- productIdstring
- productPlanIdstring
- yearinteger
- invoicePriceStatusstringDescription
- invoiceStartTimeInSecondsinteger
- invoiceUristring
- paymentCreatedInSecondsinteger
- paymentCurrencyInfoobject
- basePlanCurrencyobject
- currencyCodestring
- exchangeRatenumber
- paymentCurrencyobject
- currencyCodestring
- paymentStatusstring<PRE_PAYMENT | REQUIRES_ACTION | PENDING | FAILED | SETTLED | NOT_NEEDED | UNKNOWN>
- planBillingPeriodobject
- intervalstring<DAY | MONTH | YEAR>
- intervalsCountinteger
- planNamestring
- productItemInvoicesobject[]
- keyobject
- accountIdstring
- customerIdstring
- dayinteger
- monthinteger
- productIdstring
- productItemKeystring
- productPlanIdstring
- yearinteger
- meterApiNamestring
- productItemIdstring
- productItemNamestring
- productItemVariantsobject[]
- hourlyBillInfosobject[]
- endTimeInSecondsinteger
- meterUnitsnumber
- meteredUnitsPerTiermap<string, number>
- pricenumber
- priceInBaseCurrencynumber
- priceInCreditsnumber
- startTimeInSecondsinteger
- itemDimensionsmap<string, string>
- keystring
- lateArrivalMetersnumber
- totalBillobject
- endTimeInSecondsinteger
- meterUnitsnumber
- meteredUnitsPerTiermap<string, number>
- pricenumber
- priceInBaseCurrencynumber
- priceInCreditsnumber
- startTimeInSecondsinteger
- productPlanNamestring
- totalBillobject
- endTimeInSecondsinteger
- meterUnitsnumber
- meteredUnitsPerTiermap<string, number>
- pricenumber
- priceInBaseCurrencynumber
- priceInCreditsnumber
- startTimeInSecondsinteger
- productPlanFeesobject[]
- costnumber
- costInBaseCurrencynumber
- costInCreditsnumber
- descriptionstring
- discountableboolean
- idstring
- isOneTimeFeeboolean
- isProratedboolean
- namestring
- prepayableboolean
- prorateToDayboolean
- totalBillobject
- commitmentsFeesnumber
- discountableBasePricenumber
- discountableFixPricenumber
- endTimeInSecondsinteger
- fixPricenumber
- invoiceBasedFeesnumber
- itemPricenumber
- prepaidnumber
- prepayableCommitmentsFeesnumber
- prepayableFixPricenumber
- prepayableNotDiscountableFeesnumber
- startTimeInSecondsinteger
- totalDiscountnumber
- totalPrepayablePricenumber
- totalPricenumber
- totalPriceBeforeCommitmentsnumber
- totalPriceBeforeDiscountnumber
- totalPriceBeforePrepaidnumber
curl
curl --request GET \
--url 'https://app.amberflo.io/customer-portal/invoice?productId=1&sessionToken=string' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://app.amberflo.io/customer-portal/invoice?productId=1&sessionToken=string", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://app.amberflo.io/customer-portal/invoice?productId=1&sessionToken=string")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://app.amberflo.io/customer-portal/invoice?productId=1&sessionToken=string"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Successful response
{
"appliedCommitments": [
{
"commitmentId": "",
"feeAmount": 0,
"feeInBaseCurrency": 0,
"feeInCredits": 0,
"obligationId": "",
"obligationName": ""
}
],
"appliedInvoiceBasedFees": [
{
"feeAmount": 0,
"feeId": "",
"feeInBaseCurrency": 0,
"feeInCredits": 0,
"feeName": ""
}
],
"appliedPromotions": [
{
"canBeUsedForPayAsYouGo": false,
"dimensions": "",
"discount": 0,
"discountInBaseCurrency": 0,
"discountInCredits": 0,
"entityTd": "",
"granularity": "",
"maxDiscountInBaseCurrency": 0,
"maxDiscountPossible": 0,
"promotionAppliedTimeInSeconds": 0,
"promotionId": "",
"promotionName": "",
"promotionType": ""
}
],
"availablePayAsYouGoMoney": 0,
"availablePayAsYouGoMoneyInBaseCurrency": 0,
"availablePayAsYouGoMoneyInCredits": 0,
"availablePrepaidLeft": 0,
"availablePrepaidLeftBaseCurrency": 0,
"availablePrepaidLeftInCredits": 0,
"creditUnit": {
"active": false,
"description": "",
"id": "",
"lastUpdateTimeInMillis": 0,
"name": "",
"ratioToCurrency": 0,
"shortName": ""
},
"externalSystemStatus": "",
"gracePeriodInHours": 0,
"invoiceBillInBaseCurrency": {
"commitmentsFees": 0,
"discountableBasePrice": 0,
"discountableFixPrice": 0,
"endTimeInSeconds": 0,
"fixPrice": 0,
"invoiceBasedFees": 0,
"itemPrice": 0,
"prepaid": 0,
"prepayableCommitmentsFees": 0,
"prepayableFixPrice": 0,
"prepayableNotDiscountableFees": 0,
"startTimeInSeconds": 0,
"totalDiscount": 0,
"totalPrepayablePrice": 0,
"totalPrice": 0,
"totalPriceBeforeCommitments": 0,
"totalPriceBeforeDiscount": 0,
"totalPriceBeforePrepaid": 0
},
"invoiceBillInCredits": {
"commitmentsFees": 0,
"discountableBasePrice": 0,
"discountableFixPrice": 0,
"endTimeInSeconds": 0,
"fixPrice": 0,
"invoiceBasedFees": 0,
"itemPrice": 0,
"prepaid": 0,
"prepayableCommitmentsFees": 0,
"prepayableFixPrice": 0,
"prepayableNotDiscountableFees": 0,
"startTimeInSeconds": 0,
"totalDiscount": 0,
"totalPrepayablePrice": 0,
"totalPrice": 0,
"totalPriceBeforeCommitments": 0,
"totalPriceBeforeDiscount": 0,
"totalPriceBeforePrepaid": 0
},
"invoiceEndTimeInSeconds": 0,
"invoiceKey": {
"accountId": "",
"customerId": "",
"day": 0,
"month": 0,
"productId": "",
"productPlanId": "",
"year": 0
},
"invoicePriceStatus": "",
"invoiceStartTimeInSeconds": 0,
"invoiceUri": "",
"paymentCreatedInSeconds": 0,
"paymentCurrencyInfo": {
"basePlanCurrency": {
"currencyCode": ""
},
"exchangeRate": 0,
"paymentCurrency": {
"currencyCode": ""
}
},
"paymentStatus": "",
"planBillingPeriod": {
"interval": "",
"intervalsCount": 0
},
"planName": "",
"productItemInvoices": [
{
"key": {
"accountId": "",
"customerId": "",
"day": 0,
"month": 0,
"productId": "",
"productItemKey": "",
"productPlanId": "",
"year": 0
},
"meterApiName": "",
"productItemId": "",
"productItemName": "",
"productItemVariants": [
{
"hourlyBillInfos": [
{
"endTimeInSeconds": 0,
"meterUnits": 0,
"meteredUnitsPerTier": "",
"price": 0,
"priceInBaseCurrency": 0,
"priceInCredits": 0,
"startTimeInSeconds": 0
}
],
"itemDimensions": "",
"key": "",
"lateArrivalMeters": 0,
"totalBill": {
"endTimeInSeconds": 0,
"meterUnits": 0,
"meteredUnitsPerTier": "",
"price": 0,
"priceInBaseCurrency": 0,
"priceInCredits": 0,
"startTimeInSeconds": 0
}
}
],
"productPlanName": "",
"totalBill": {
"endTimeInSeconds": 0,
"meterUnits": 0,
"meteredUnitsPerTier": "",
"price": 0,
"priceInBaseCurrency": 0,
"priceInCredits": 0,
"startTimeInSeconds": 0
}
}
],
"productPlanFees": [
{
"cost": 0,
"costInBaseCurrency": 0,
"costInCredits": 0,
"description": "",
"discountable": false,
"id": "",
"isOneTimeFee": false,
"isProrated": false,
"name": "",
"prepayable": false,
"prorateToDay": false
}
],
"totalBill": {
"commitmentsFees": 0,
"discountableBasePrice": 0,
"discountableFixPrice": 0,
"endTimeInSeconds": 0,
"fixPrice": 0,
"invoiceBasedFees": 0,
"itemPrice": 0,
"prepaid": 0,
"prepayableCommitmentsFees": 0,
"prepayableFixPrice": 0,
"prepayableNotDiscountableFees": 0,
"startTimeInSeconds": 0,
"totalDiscount": 0,
"totalPrepayablePrice": 0,
"totalPrice": 0,
"totalPriceBeforeCommitments": 0,
"totalPriceBeforeDiscount": 0,
"totalPriceBeforePrepaid": 0
}
}