/payments/billing/customer-product-invoice/paginated

1 min

GET

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

Responses

200Successful request

payment.billing.detailed.api.DetailedCustomerProductInvoiceResponse.out
- pageInfopayment.common.PageInfo.out
  - pageNumberinteger<int32>
  - pageSizeinteger<int32>
  - pageTokenstring
  - totalPagesinteger<int32>
  - totalResultsinteger<int32>
- datapayment.billing.detailed.DetailedCustomerProductInvoice.out[]
  - invoiceUristring
  - uuidstring
  - invoiceKeypayment.billing.CustomerProductInvoiceKey.out
    - accountIdstring
    - customerIdstring
    - productIdstring
    - productPlanIdstring
    - yearinteger<int32>
    - monthinteger<int32>
    - dayinteger<int32>
  - planBillingPeriodpayment.pricing.BillingPeriod.out
    - intervalpayment.pricing.BillingPeriodInterval.out
    - intervalsCountinteger<int32>
  - planNamestring
  - invoiceStartTimeInSecondsinteger<int64>
  - invoiceEndTimeInSecondsinteger<int64>
  - gracePeriodInHoursinteger<int32>
  - productItemInvoicespayment.billing.detailed.DetailedCustomerProductItemInvoice.out[]
    - keypayment.billing.CustomerProductItemInvoiceKey.out
      - accountIdstring
      - customerIdstring
      - productIdstring
      - productPlanIdstring
      - yearinteger<int32>
      - monthinteger<int32>
      - dayinteger<int32>
      - productItemKeystring
    - productItemIdstring
    - productItemNamestring
    - meterApiNamestring
    - productPlanNamestring
    - productItemInvoiceLabelstring
    - scalarnumber
    - productItemVariantspayment.billing.detailed.DetailedProductItemVariantInvoice.out[]
      - keystring
      - itemDimensionsmap<string, string>
      - dimensionLabelstring
      - hourlyBillInfospayment.billing.detailed.DetailedItemVariantBill.out[]
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
        meterUnitsnumber
        pricenumber
        meteredUnitsPerTiermap<string, number>
        pricePerTiermap<string, number>
        primaryMeterUnitNamestring
        secondaryMeterUnitsPerTiermap<string, object>
        secondaryPricePerTiermap<string, object>
        priceInCreditsnumber
        priceInBaseCurrencynumber
      - totalBillpayment.billing.detailed.DetailedItemVariantBill.out
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
        meterUnitsnumber
        pricenumber
        meteredUnitsPerTiermap<string, number>
        pricePerTiermap<string, number>
        primaryMeterUnitNamestring
        secondaryMeterUnitsPerTiermap<string, object>
        secondaryPricePerTiermap<string, object>
        priceInCreditsnumber
        priceInBaseCurrencynumber
      - lateArrivalMetersnumber
    - totalBillpayment.billing.detailed.DetailedItemVariantBill.out
      - startTimeInSecondsinteger<int64>
      - endTimeInSecondsinteger<int64>
      - meterUnitsnumber
      - pricenumber
      - meteredUnitsPerTiermap<string, number>
      - pricePerTiermap<string, number>
      - primaryMeterUnitNamestring
      - secondaryMeterUnitsPerTiermap<string, object>
      - secondaryPricePerTiermap<string, object>
      - priceInCreditsnumber
      - priceInBaseCurrencynumber
  - appliedPromotionspayment.billing.detailed.DetailedInvoiceAppliedPromotion.out[]
    - customerAppliedPromotionIdstring
    - promotionIdstring
    - promotionNamestring
    - promotionTypepayment.pricing.promotions.attributes.PromotionType.out
    - discountnumber
    - hourlyDiscountsmap<string, number>
    - promotionAppliedTimeInSecondsinteger<int64>
    - maxDiscountPossiblenumber
    - canBeUsedForPayAsYouGoboolean
    - granularitystring
    - entityTdstring
    - dimensionsmap<string, string>
    - promotionAppliedTimeRangepayment.common.TimeRange.out
      - startTimeInSecondsinteger<int64>
      - endTimeInSecondsinteger<int64>
    - discountInCreditsnumber
    - discountInBaseCurrencynumber
    - maxDiscountInBaseCurrencynumber
  - appliedPrepaidspayment.billing.detailed.DetailedInvoiceAppliedPrepaid.out[]
    - prepaidUristring
  - productPlanFeespayment.billing.detailed.DetailedProductPlanFee.out[]
    - idstring
    - namestring
    - descriptionstring
    - costnumber
    - isOneTimeFeeboolean
    - isProratedboolean
    - prorateToDayboolean
    - discountableboolean
    - prepayableboolean
    - costInCreditsnumber
    - costInBaseCurrencynumber
  - appliedInvoiceBasedFeespayment.billing.detailed.DetailedInvoiceBasedAppliedFee.out[]
    - feeIdstring
    - feeNamestring
    - feeAmountnumber
    - feeByTimeInSecondsmap<string, number>
    - feeInCreditsnumber
    - feeInBaseCurrencynumber
  - appliedInvoiceSpendingLimitFeespayment.billing.detailed.DetailedInvoiceAppliedSpendingLimitFee.out[]
    - idstring
    - labelstring
    - feeAmountnumber
    - feeAmountInCreditsnumber
    - feeAmountInBaseCurrencynumber
  - appliedCommitmentspayment.billing.detailed.DetailedInvoiceAppliedCommitmentFee.out[]
    - commitmentIdstring
    - obligationIdstring
    - obligationNamestring
    - feeAmountnumber
    - feeInCreditsnumber
    - feeInBaseCurrencynumber
  - itemSubscriptionDetailspayment.billing.SubscriptionItemDetail.out[]
    - productItemIdstring
    - variantSubscriptionDetailspayment.billing.SubscriptionVariantDetail.out[]
      - groupInfopayment.meters.GroupInfo.out
        gimap<string, string>
      - hourlyUsagepayment.billing.SubscriptionUsage.out[]
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
        subscriptionUnitsnumber
        overageUnitsnumber
  - totalBillpayment.billing.ProductPlanBill.out
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
    - totalPricenumber
    - itemPricenumber
    - fixPricenumber
    - invoiceBasedFeesnumber
    - invoiceSpendingLimitFeesnumber
    - commitmentsFeesnumber
    - prepaidnumber
    - totalDiscountnumber
    - totalPriceBeforeDiscountnumber
    - totalPriceBeforePrepaidnumber
    - totalPriceBeforeCommitmentsnumber
    - totalPriceBeforeSalesTaxnumber
    - discountableFixPricenumber
    - discountableBasePricenumber
    - prepayableFixPricenumber
    - prepayableNotDiscountableFeesnumber
    - prepayableCommitmentsFeesnumber
    - totalPrepayablePricenumber
  - invoicePriceStatuspayment.billing.InvoiceStatus.out
  - creditUnitpayment.pricing.CreditUnit.out
    - idstring
    - shortNamestring
    - namestring
    - ratioToCurrencynumber
    - descriptionstring
    - activeboolean
    - lastUpdateTimeInMillisinteger<int64>
  - paymentStatuspayment.payment.PaymentStatus.out
  - paymentCreatedInSecondsinteger<int64>
  - externalSystemStatusstring
  - invoiceBillInBaseCurrencypayment.billing.ProductPlanBill.out
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
    - totalPricenumber
    - itemPricenumber
    - fixPricenumber
    - invoiceBasedFeesnumber
    - invoiceSpendingLimitFeesnumber
    - commitmentsFeesnumber
    - prepaidnumber
    - totalDiscountnumber
    - totalPriceBeforeDiscountnumber
    - totalPriceBeforePrepaidnumber
    - totalPriceBeforeCommitmentsnumber
    - totalPriceBeforeSalesTaxnumber
    - discountableFixPricenumber
    - discountableBasePricenumber
    - prepayableFixPricenumber
    - prepayableNotDiscountableFeesnumber
    - prepayableCommitmentsFeesnumber
    - totalPrepayablePricenumber
  - invoiceBillInCreditspayment.billing.ProductPlanBill.out
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
    - totalPricenumber
    - itemPricenumber
    - fixPricenumber
    - invoiceBasedFeesnumber
    - invoiceSpendingLimitFeesnumber
    - commitmentsFeesnumber
    - prepaidnumber
    - totalDiscountnumber
    - totalPriceBeforeDiscountnumber
    - totalPriceBeforePrepaidnumber
    - totalPriceBeforeCommitmentsnumber
    - totalPriceBeforeSalesTaxnumber
    - discountableFixPricenumber
    - discountableBasePricenumber
    - prepayableFixPricenumber
    - prepayableNotDiscountableFeesnumber
    - prepayableCommitmentsFeesnumber
    - totalPrepayablePricenumber
  - prepaidPriceUsedBaseCurrencynumber
  - prepaidPriceUsednumber
  - availablePrepaidLeftnumber
  - availablePrepaidLeftBaseCurrencynumber
  - prepaidUsageUsednumber
  - availablePrepaidUsageLeftnumber
  - availablePrepaidLeftInCreditsnumber
  - invoiceSalesTaxcom.amberflo.integration.tax.InvoiceSalesTax.out
    - totalTaxAmountnumber
      Description
      The total tax for all lines in this transaction
    - totalTaxableAmountnumber
      Description
      The portion of the total amount of this transaction that was taxable
    - totalExemptAmountnumber
      Description
      The amount of this transaction that was exempt
    - combinedTaxRatenumber
      Description
      The rate of taxation, as a fraction of the amount
    - hasNexusboolean
      Description
      Has nexus
    - taxCodestring
      Description
      The tax code
  - availablePayAsYouGoMoneynumber
  - availablePayAsYouGoMoneyInBaseCurrencynumber
  - availablePayAsYouGoMoneyInCreditsnumber
  - paymentCurrencyInfopayment.billing.PaymentCurrencyInfo.out
    - basePlanCurrencystring
      Example
      USD
      Description
      Currency code in ISO 4217 format.
    - paymentCurrencystring
      Example
      USD
      Description
      Currency code in ISO 4217 format.
    - exchangeRatenumber
  - paymentMethodpayment.payment.PaymentMethod.out
    - methodTypestring
    - last4string
    - brandstring
  - messagescom.amberflo.service.common.log_message.LogMessage.out[]
    - levelcom.amberflo.service.common.log_message.MessageLevel.out
    - codecom.amberflo.service.common.log_message.MessageCode.out
    - messagestring
  - invoiceStartTimestring
  - invoiceEndTimestring
  - voidedboolean

curl

curl --request GET \
     --url https://app.amberflo.io/payments/billing/customer-product-invoice/paginated \
     --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/payments/billing/customer-product-invoice/paginated", 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/payments/billing/customer-product-invoice/paginated")

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/payments/billing/customer-product-invoice/paginated"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "pageInfo": {
    "pageNumber": "",
    "pageSize": "",
    "pageToken": "",
    "totalPages": "",
    "totalResults": ""
  },
  "data": [
    {
      "invoiceUri": "",
      "uuid": "",
      "invoiceKey": {
        "accountId": "",
        "customerId": "",
        "productId": "",
        "productPlanId": "",
        "year": "",
        "month": "",
        "day": ""
      },
      "planBillingPeriod": {
        "interval": "",
        "intervalsCount": ""
      },
      "planName": "",
      "invoiceStartTimeInSeconds": "",
      "invoiceEndTimeInSeconds": "",
      "gracePeriodInHours": "",
      "productItemInvoices": [
        {
          "key": {
            "accountId": "",
            "customerId": "",
            "productId": "",
            "productPlanId": "",
            "year": "",
            "month": "",
            "day": "",
            "productItemKey": ""
          },
          "productItemId": "",
          "productItemName": "",
          "meterApiName": "",
          "productPlanName": "",
          "productItemInvoiceLabel": "",
          "scalar": 0,
          "productItemVariants": [
            {
              "key": "",
              "itemDimensions": "",
              "dimensionLabel": "",
              "hourlyBillInfos": [
                {
                  "startTimeInSeconds": "",
                  "endTimeInSeconds": "",
                  "meterUnits": 0,
                  "price": 0,
                  "meteredUnitsPerTier": "",
                  "pricePerTier": "",
                  "primaryMeterUnitName": "",
                  "secondaryMeterUnitsPerTier": "",
                  "secondaryPricePerTier": "",
                  "priceInCredits": 0,
                  "priceInBaseCurrency": 0
                }
              ],
              "totalBill": {
                "startTimeInSeconds": "",
                "endTimeInSeconds": "",
                "meterUnits": 0,
                "price": 0,
                "meteredUnitsPerTier": "",
                "pricePerTier": "",
                "primaryMeterUnitName": "",
                "secondaryMeterUnitsPerTier": "",
                "secondaryPricePerTier": "",
                "priceInCredits": 0,
                "priceInBaseCurrency": 0
              },
              "lateArrivalMeters": 0
            }
          ],
          "totalBill": {
            "startTimeInSeconds": "",
            "endTimeInSeconds": "",
            "meterUnits": 0,
            "price": 0,
            "meteredUnitsPerTier": "",
            "pricePerTier": "",
            "primaryMeterUnitName": "",
            "secondaryMeterUnitsPerTier": "",
            "secondaryPricePerTier": "",
            "priceInCredits": 0,
            "priceInBaseCurrency": 0
          }
        }
      ],
      "appliedPromotions": [
        {
          "customerAppliedPromotionId": "",
          "promotionId": "",
          "promotionName": "",
          "promotionType": "",
          "discount": 0,
          "hourlyDiscounts": "",
          "promotionAppliedTimeInSeconds": "",
          "maxDiscountPossible": 0,
          "canBeUsedForPayAsYouGo": false,
          "granularity": "",
          "entityTd": "",
          "dimensions": "",
          "promotionAppliedTimeRange": {
            "startTimeInSeconds": "",
            "endTimeInSeconds": ""
          },
          "discountInCredits": 0,
          "discountInBaseCurrency": 0,
          "maxDiscountInBaseCurrency": 0
        }
      ],
      "appliedPrepaids": [
        {
          "prepaidUri": ""
        }
      ],
      "productPlanFees": [
        {
          "id": "",
          "name": "",
          "description": "",
          "cost": 0,
          "isOneTimeFee": false,
          "isProrated": false,
          "prorateToDay": false,
          "discountable": false,
          "prepayable": false,
          "costInCredits": 0,
          "costInBaseCurrency": 0
        }
      ],
      "appliedInvoiceBasedFees": [
        {
          "feeId": "",
          "feeName": "",
          "feeAmount": 0,
          "feeByTimeInSeconds": "",
          "feeInCredits": 0,
          "feeInBaseCurrency": 0
        }
      ],
      "appliedInvoiceSpendingLimitFees": [
        {
          "id": "",
          "label": "",
          "feeAmount": 0,
          "feeAmountInCredits": 0,
          "feeAmountInBaseCurrency": 0
        }
      ],
      "appliedCommitments": [
        {
          "commitmentId": "",
          "obligationId": "",
          "obligationName": "",
          "feeAmount": 0,
          "feeInCredits": 0,
          "feeInBaseCurrency": 0
        }
      ],
      "itemSubscriptionDetails": [
        {
          "productItemId": "",
          "variantSubscriptionDetails": [
            {
              "groupInfo": {
                "gi": ""
              },
              "hourlyUsage": [
                {
                  "startTimeInSeconds": "",
                  "endTimeInSeconds": "",
                  "subscriptionUnits": 0,
                  "overageUnits": 0
                }
              ]
            }
          ]
        }
      ],
      "totalBill": {
        "startTimeInSeconds": "",
        "endTimeInSeconds": "",
        "totalPrice": 0,
        "itemPrice": 0,
        "fixPrice": 0,
        "invoiceBasedFees": 0,
        "invoiceSpendingLimitFees": 0,
        "commitmentsFees": 0,
        "prepaid": 0,
        "totalDiscount": 0,
        "totalPriceBeforeDiscount": 0,
        "totalPriceBeforePrepaid": 0,
        "totalPriceBeforeCommitments": 0,
        "totalPriceBeforeSalesTax": 0,
        "discountableFixPrice": 0,
        "discountableBasePrice": 0,
        "prepayableFixPrice": 0,
        "prepayableNotDiscountableFees": 0,
        "prepayableCommitmentsFees": 0,
        "totalPrepayablePrice": 0
      },
      "invoicePriceStatus": "",
      "creditUnit": {
        "id": "",
        "shortName": "",
        "name": "",
        "ratioToCurrency": 0,
        "description": "",
        "active": false,
        "lastUpdateTimeInMillis": ""
      },
      "paymentStatus": "",
      "paymentCreatedInSeconds": "",
      "externalSystemStatus": "",
      "invoiceBillInBaseCurrency": {
        "startTimeInSeconds": "",
        "endTimeInSeconds": "",
        "totalPrice": 0,
        "itemPrice": 0,
        "fixPrice": 0,
        "invoiceBasedFees": 0,
        "invoiceSpendingLimitFees": 0,
        "commitmentsFees": 0,
        "prepaid": 0,
        "totalDiscount": 0,
        "totalPriceBeforeDiscount": 0,
        "totalPriceBeforePrepaid": 0,
        "totalPriceBeforeCommitments": 0,
        "totalPriceBeforeSalesTax": 0,
        "discountableFixPrice": 0,
        "discountableBasePrice": 0,
        "prepayableFixPrice": 0,
        "prepayableNotDiscountableFees": 0,
        "prepayableCommitmentsFees": 0,
        "totalPrepayablePrice": 0
      },
      "invoiceBillInCredits": {
        "startTimeInSeconds": "",
        "endTimeInSeconds": "",
        "totalPrice": 0,
        "itemPrice": 0,
        "fixPrice": 0,
        "invoiceBasedFees": 0,
        "invoiceSpendingLimitFees": 0,
        "commitmentsFees": 0,
        "prepaid": 0,
        "totalDiscount": 0,
        "totalPriceBeforeDiscount": 0,
        "totalPriceBeforePrepaid": 0,
        "totalPriceBeforeCommitments": 0,
        "totalPriceBeforeSalesTax": 0,
        "discountableFixPrice": 0,
        "discountableBasePrice": 0,
        "prepayableFixPrice": 0,
        "prepayableNotDiscountableFees": 0,
        "prepayableCommitmentsFees": 0,
        "totalPrepayablePrice": 0
      },
      "prepaidPriceUsedBaseCurrency": 0,
      "prepaidPriceUsed": 0,
      "availablePrepaidLeft": 0,
      "availablePrepaidLeftBaseCurrency": 0,
      "prepaidUsageUsed": 0,
      "availablePrepaidUsageLeft": 0,
      "availablePrepaidLeftInCredits": 0,
      "invoiceSalesTax": {
        "totalTaxAmount": 0,
        "totalTaxableAmount": 0,
        "totalExemptAmount": 0,
        "combinedTaxRate": 0,
        "hasNexus": false,
        "taxCode": ""
      },
      "availablePayAsYouGoMoney": 0,
      "availablePayAsYouGoMoneyInBaseCurrency": 0,
      "availablePayAsYouGoMoneyInCredits": 0,
      "paymentCurrencyInfo": {
        "basePlanCurrency": "USD",
        "paymentCurrency": "USD",
        "exchangeRate": 0
      },
      "paymentMethod": {
        "methodType": "",
        "last4": "",
        "brand": ""
      },
      "messages": [
        {
          "level": "",
          "code": "",
          "message": ""
        }
      ],
      "invoiceStartTime": "",
      "invoiceEndTime": "",
      "voided": false
    }
  ]
}