--- title: /payments/billing/customer-product-invoice/paginated slug: amberflo-api/paymentsbillingcustomer-product-invoicepaginated createdAt: 2024-11-07T15:10:16.974Z --- { "id": "2MmHhiH3NjqMaTpjfVPKN", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://app.amberflo.io/payments/billing/customer-product-invoice/paginated", "servers": [ { "url": "https://app.amberflo.io/payments/billing/customer-product-invoice/paginated" } ], "name": "", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "payment.billing.detailed.api.DetailedCustomerProductInvoiceResponse.out", "schema": [ { "name": "pageInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.PageInfo.out", "customType": "payment.common.PageInfo.out", "schema": [ { "name": "pageNumber", "kind": "optional", "type": "integer", "example": 0 }, { "name": "pageSize", "kind": "optional", "type": "integer", "example": 0 }, { "name": "pageToken", "kind": "optional", "type": "string", "example": "" }, { "name": "totalPages", "kind": "optional", "type": "integer", "example": 0 }, { "name": "totalResults", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "data", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedCustomerProductInvoice.out", "customType": "payment.billing.detailed.DetailedCustomerProductInvoice.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "uuid", "kind": "optional", "type": "string", "example": "" }, { "name": "invoiceKey", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.CustomerProductInvoiceKey.out", "customType": "payment.billing.CustomerProductInvoiceKey.out", "schema": [ { "name": "accountId", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "productPlanId", "kind": "optional", "type": "string", "example": "" }, { "name": "year", "kind": "optional", "type": "integer", "example": 0 }, { "name": "month", "kind": "optional", "type": "integer", "example": 0 }, { "name": "day", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planBillingPeriod", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planName", "kind": "optional", "type": "string", "example": "" }, { "name": "invoiceStartTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "invoiceEndTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "gracePeriodInHours", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productItemInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedCustomerProductItemInvoice.out", "customType": "payment.billing.detailed.DetailedCustomerProductItemInvoice.out[]", "schema": [ { "name": "key", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.CustomerProductItemInvoiceKey.out", "customType": "payment.billing.CustomerProductItemInvoiceKey.out", "schema": [ { "name": "accountId", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "productPlanId", "kind": "optional", "type": "string", "example": "" }, { "name": "year", "kind": "optional", "type": "integer", "example": 0 }, { "name": "month", "kind": "optional", "type": "integer", "example": 0 }, { "name": "day", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productItemKey", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "productItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "productItemName", "kind": "optional", "type": "string", "example": "" }, { "name": "meterApiName", "kind": "optional", "type": "string", "example": "" }, { "name": "productPlanName", "kind": "optional", "type": "string", "example": "" }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "example": "" }, { "name": "scalar", "kind": "optional", "type": "number", "example": "" }, { "name": "productItemVariants", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedProductItemVariantInvoice.out", "customType": "payment.billing.detailed.DetailedProductItemVariantInvoice.out[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "example": "" }, { "name": "itemDimensions", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "dimensionLabel", "kind": "optional", "type": "string", "example": "" }, { "name": "hourlyBillInfos", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedItemVariantBill.out", "customType": "payment.billing.detailed.DetailedItemVariantBill.out[]", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "meterUnits", "kind": "optional", "type": "number", "example": "" }, { "name": "price", "kind": "optional", "type": "number", "example": "" }, { "name": "meteredUnitsPerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "pricePerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "primaryMeterUnitName", "kind": "optional", "type": "string", "example": "" }, { "name": "secondaryMeterUnitsPerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "secondaryPricePerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "priceInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "priceInBaseCurrency", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "totalBill", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedItemVariantBill.out", "customType": "payment.billing.detailed.DetailedItemVariantBill.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "meterUnits", "kind": "optional", "type": "number", "example": "" }, { "name": "price", "kind": "optional", "type": "number", "example": "" }, { "name": "meteredUnitsPerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "pricePerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "primaryMeterUnitName", "kind": "optional", "type": "string", "example": "" }, { "name": "secondaryMeterUnitsPerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "secondaryPricePerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "priceInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "priceInBaseCurrency", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "lateArrivalMeters", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "totalBill", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedItemVariantBill.out", "customType": "payment.billing.detailed.DetailedItemVariantBill.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "meterUnits", "kind": "optional", "type": "number", "example": "" }, { "name": "price", "kind": "optional", "type": "number", "example": "" }, { "name": "meteredUnitsPerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "pricePerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "primaryMeterUnitName", "kind": "optional", "type": "string", "example": "" }, { "name": "secondaryMeterUnitsPerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "secondaryPricePerTier", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "priceInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "priceInBaseCurrency", "kind": "optional", "type": "number", "example": "" } ] } ] }, { "name": "appliedPromotions", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedInvoiceAppliedPromotion.out", "customType": "payment.billing.detailed.DetailedInvoiceAppliedPromotion.out[]", "schema": [ { "name": "customerAppliedPromotionId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionName", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.PromotionType.out", "customType": "payment.pricing.promotions.attributes.PromotionType.out", "schema": [] }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "hourlyDiscounts", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "promotionAppliedTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "maxDiscountPossible", "kind": "optional", "type": "number", "example": "" }, { "name": "canBeUsedForPayAsYouGo", "kind": "optional", "type": "boolean", "example": "" }, { "name": "granularity", "kind": "optional", "type": "string", "example": "" }, { "name": "entityTd", "kind": "optional", "type": "string", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "promotionAppliedTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "discountInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "discountInBaseCurrency", "kind": "optional", "type": "number", "example": "" }, { "name": "maxDiscountInBaseCurrency", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "appliedPrepaids", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedInvoiceAppliedPrepaid.out", "customType": "payment.billing.detailed.DetailedInvoiceAppliedPrepaid.out[]", "schema": [ { "name": "prepaidUri", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "productPlanFees", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedProductPlanFee.out", "customType": "payment.billing.detailed.DetailedProductPlanFee.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "cost", "kind": "optional", "type": "number", "example": "" }, { "name": "isOneTimeFee", "kind": "optional", "type": "boolean", "example": "" }, { "name": "isProrated", "kind": "optional", "type": "boolean", "example": "" }, { "name": "prorateToDay", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discountable", "kind": "optional", "type": "boolean", "example": "" }, { "name": "prepayable", "kind": "optional", "type": "boolean", "example": "" }, { "name": "costInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "costInBaseCurrency", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "appliedInvoiceBasedFees", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedInvoiceBasedAppliedFee.out", "customType": "payment.billing.detailed.DetailedInvoiceBasedAppliedFee.out[]", "schema": [ { "name": "feeId", "kind": "optional", "type": "string", "example": "" }, { "name": "feeName", "kind": "optional", "type": "string", "example": "" }, { "name": "feeAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "feeByTimeInSeconds", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "feeInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "feeInBaseCurrency", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "appliedInvoiceSpendingLimitFees", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedInvoiceAppliedSpendingLimitFee.out", "customType": "payment.billing.detailed.DetailedInvoiceAppliedSpendingLimitFee.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "feeAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "feeAmountInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "feeAmountInBaseCurrency", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "appliedCommitments", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.DetailedInvoiceAppliedCommitmentFee.out", "customType": "payment.billing.detailed.DetailedInvoiceAppliedCommitmentFee.out[]", "schema": [ { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "obligationId", "kind": "optional", "type": "string", "example": "" }, { "name": "obligationName", "kind": "optional", "type": "string", "example": "" }, { "name": "feeAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "feeInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "feeInBaseCurrency", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "itemSubscriptionDetails", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.SubscriptionItemDetail.out", "customType": "payment.billing.SubscriptionItemDetail.out[]", "schema": [ { "name": "productItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "variantSubscriptionDetails", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.SubscriptionVariantDetail.out", "customType": "payment.billing.SubscriptionVariantDetail.out[]", "schema": [ { "name": "groupInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.meters.GroupInfo.out", "customType": "payment.meters.GroupInfo.out", "schema": [ { "name": "gi", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "hourlyUsage", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.SubscriptionUsage.out", "customType": "payment.billing.SubscriptionUsage.out[]", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "subscriptionUnits", "kind": "optional", "type": "number", "example": "" }, { "name": "overageUnits", "kind": "optional", "type": "number", "example": "" } ] } ] } ] }, { "name": "totalBill", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.ProductPlanBill.out", "customType": "payment.billing.ProductPlanBill.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "totalPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "itemPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "fixPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceBasedFees", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceSpendingLimitFees", "kind": "optional", "type": "number", "example": "" }, { "name": "commitmentsFees", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaid", "kind": "optional", "type": "number", "example": "" }, { "name": "totalDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforeDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforePrepaid", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforeCommitments", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforeSalesTax", "kind": "optional", "type": "number", "example": "" }, { "name": "discountableFixPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "discountableBasePrice", "kind": "optional", "type": "number", "example": "" }, { "name": "prepayableFixPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "prepayableNotDiscountableFees", "kind": "optional", "type": "number", "example": "" }, { "name": "prepayableCommitmentsFees", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPrepayablePrice", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "invoicePriceStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.InvoiceStatus.out", "customType": "payment.billing.InvoiceStatus.out", "schema": [] }, { "name": "creditUnit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.CreditUnit.out", "customType": "payment.pricing.CreditUnit.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "shortName", "kind": "optional", "type": "string", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "example": "" }, { "name": "ratioToCurrency", "kind": "optional", "type": "number", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "active", "kind": "optional", "type": "boolean", "example": "" }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "paymentCreatedInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "externalSystemStatus", "kind": "optional", "type": "string", "example": "" }, { "name": "invoiceBillInBaseCurrency", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.ProductPlanBill.out", "customType": "payment.billing.ProductPlanBill.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "totalPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "itemPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "fixPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceBasedFees", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceSpendingLimitFees", "kind": "optional", "type": "number", "example": "" }, { "name": "commitmentsFees", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaid", "kind": "optional", "type": "number", "example": "" }, { "name": "totalDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforeDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforePrepaid", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforeCommitments", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforeSalesTax", "kind": "optional", "type": "number", "example": "" }, { "name": "discountableFixPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "discountableBasePrice", "kind": "optional", "type": "number", "example": "" }, { "name": "prepayableFixPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "prepayableNotDiscountableFees", "kind": "optional", "type": "number", "example": "" }, { "name": "prepayableCommitmentsFees", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPrepayablePrice", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "invoiceBillInCredits", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.ProductPlanBill.out", "customType": "payment.billing.ProductPlanBill.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "totalPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "itemPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "fixPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceBasedFees", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceSpendingLimitFees", "kind": "optional", "type": "number", "example": "" }, { "name": "commitmentsFees", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaid", "kind": "optional", "type": "number", "example": "" }, { "name": "totalDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforeDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforePrepaid", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforeCommitments", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPriceBeforeSalesTax", "kind": "optional", "type": "number", "example": "" }, { "name": "discountableFixPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "discountableBasePrice", "kind": "optional", "type": "number", "example": "" }, { "name": "prepayableFixPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "prepayableNotDiscountableFees", "kind": "optional", "type": "number", "example": "" }, { "name": "prepayableCommitmentsFees", "kind": "optional", "type": "number", "example": "" }, { "name": "totalPrepayablePrice", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "prepaidPriceUsedBaseCurrency", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidPriceUsed", "kind": "optional", "type": "number", "example": "" }, { "name": "availablePrepaidLeft", "kind": "optional", "type": "number", "example": "" }, { "name": "availablePrepaidLeftBaseCurrency", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidUsageUsed", "kind": "optional", "type": "number", "example": "" }, { "name": "availablePrepaidUsageLeft", "kind": "optional", "type": "number", "example": "" }, { "name": "availablePrepaidLeftInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceSalesTax", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/com.amberflo.integration.tax.InvoiceSalesTax.out", "customType": "com.amberflo.integration.tax.InvoiceSalesTax.out", "schema": [ { "name": "totalTaxAmount", "kind": "optional", "type": "number", "description": "The total tax for all lines in this transaction", "example": "" }, { "name": "totalTaxableAmount", "kind": "optional", "type": "number", "description": "The portion of the total amount of this transaction that was taxable", "example": "" }, { "name": "totalExemptAmount", "kind": "optional", "type": "number", "description": "The amount of this transaction that was exempt", "example": "" }, { "name": "combinedTaxRate", "kind": "optional", "type": "number", "description": "The rate of taxation, as a fraction of the amount", "example": "" }, { "name": "hasNexus", "kind": "optional", "type": "boolean", "description": "Has nexus", "example": "" }, { "name": "taxCode", "kind": "optional", "type": "string", "description": "The tax code", "example": "" } ] }, { "name": "availablePayAsYouGoMoney", "kind": "optional", "type": "number", "example": "" }, { "name": "availablePayAsYouGoMoneyInBaseCurrency", "kind": "optional", "type": "number", "example": "" }, { "name": "availablePayAsYouGoMoneyInCredits", "kind": "optional", "type": "number", "example": "" }, { "name": "paymentCurrencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.out", "customType": "payment.billing.PaymentCurrencyInfo.out", "schema": [ { "name": "basePlanCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "paymentCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "exchangeRate", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "paymentMethod", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentMethod.out", "customType": "payment.payment.PaymentMethod.out", "schema": [ { "name": "methodType", "kind": "optional", "type": "string", "example": "" }, { "name": "last4", "kind": "optional", "type": "string", "example": "" }, { "name": "brand", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "messages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.log_message.LogMessage.out", "customType": "com.amberflo.service.common.log_message.LogMessage.out[]", "schema": [ { "name": "level", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.log_message.MessageLevel.out", "customType": "com.amberflo.service.common.log_message.MessageLevel.out", "schema": [] }, { "name": "code", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.log_message.MessageCode.out", "customType": "com.amberflo.service.common.log_message.MessageCode.out", "schema": [] }, { "name": "message", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "invoiceStartTime", "kind": "optional", "type": "string", "example": "" }, { "name": "invoiceEndTime", "kind": "optional", "type": "string", "example": "" }, { "name": "voided", "kind": "optional", "type": "boolean", "example": "" } ] } ], "modelRef": "#/components/schemas/payment.billing.detailed.api.DetailedCustomerProductInvoiceResponse.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/payments/billing/customer-product-invoice/paginated \\\n --header 'accept: application/json'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/billing/customer-product-invoice/paginated\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/billing/customer-product-invoice/paginated\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/billing/customer-product-invoice/paginated\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful request\n{\n \"pageInfo\": {\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"pageToken\": \"\",\n \"totalPages\": \"\",\n \"totalResults\": \"\"\n },\n \"data\": [\n {\n \"invoiceUri\": \"\",\n \"uuid\": \"\",\n \"invoiceKey\": {\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"productId\": \"\",\n \"productPlanId\": \"\",\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"planBillingPeriod\": {\n \"interval\": \"\",\n \"intervalsCount\": \"\"\n },\n \"planName\": \"\",\n \"invoiceStartTimeInSeconds\": \"\",\n \"invoiceEndTimeInSeconds\": \"\",\n \"gracePeriodInHours\": \"\",\n \"productItemInvoices\": [\n {\n \"key\": {\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"productId\": \"\",\n \"productPlanId\": \"\",\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\",\n \"productItemKey\": \"\"\n },\n \"productItemId\": \"\",\n \"productItemName\": \"\",\n \"meterApiName\": \"\",\n \"productPlanName\": \"\",\n \"productItemInvoiceLabel\": \"\",\n \"scalar\": 0,\n \"productItemVariants\": [\n {\n \"key\": \"\",\n \"itemDimensions\": \"\",\n \"dimensionLabel\": \"\",\n \"hourlyBillInfos\": [\n {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"meterUnits\": 0,\n \"price\": 0,\n \"meteredUnitsPerTier\": \"\",\n \"pricePerTier\": \"\",\n \"primaryMeterUnitName\": \"\",\n \"secondaryMeterUnitsPerTier\": \"\",\n \"secondaryPricePerTier\": \"\",\n \"priceInCredits\": 0,\n \"priceInBaseCurrency\": 0\n }\n ],\n \"totalBill\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"meterUnits\": 0,\n \"price\": 0,\n \"meteredUnitsPerTier\": \"\",\n \"pricePerTier\": \"\",\n \"primaryMeterUnitName\": \"\",\n \"secondaryMeterUnitsPerTier\": \"\",\n \"secondaryPricePerTier\": \"\",\n \"priceInCredits\": 0,\n \"priceInBaseCurrency\": 0\n },\n \"lateArrivalMeters\": 0\n }\n ],\n \"totalBill\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"meterUnits\": 0,\n \"price\": 0,\n \"meteredUnitsPerTier\": \"\",\n \"pricePerTier\": \"\",\n \"primaryMeterUnitName\": \"\",\n \"secondaryMeterUnitsPerTier\": \"\",\n \"secondaryPricePerTier\": \"\",\n \"priceInCredits\": 0,\n \"priceInBaseCurrency\": 0\n }\n }\n ],\n \"appliedPromotions\": [\n {\n \"customerAppliedPromotionId\": \"\",\n \"promotionId\": \"\",\n \"promotionName\": \"\",\n \"promotionType\": \"\",\n \"discount\": 0,\n \"hourlyDiscounts\": \"\",\n \"promotionAppliedTimeInSeconds\": \"\",\n \"maxDiscountPossible\": 0,\n \"canBeUsedForPayAsYouGo\": false,\n \"granularity\": \"\",\n \"entityTd\": \"\",\n \"dimensions\": \"\",\n \"promotionAppliedTimeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"discountInCredits\": 0,\n \"discountInBaseCurrency\": 0,\n \"maxDiscountInBaseCurrency\": 0\n }\n ],\n \"appliedPrepaids\": [\n {\n \"prepaidUri\": \"\"\n }\n ],\n \"productPlanFees\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"cost\": 0,\n \"isOneTimeFee\": false,\n \"isProrated\": false,\n \"prorateToDay\": false,\n \"discountable\": false,\n \"prepayable\": false,\n \"costInCredits\": 0,\n \"costInBaseCurrency\": 0\n }\n ],\n \"appliedInvoiceBasedFees\": [\n {\n \"feeId\": \"\",\n \"feeName\": \"\",\n \"feeAmount\": 0,\n \"feeByTimeInSeconds\": \"\",\n \"feeInCredits\": 0,\n \"feeInBaseCurrency\": 0\n }\n ],\n \"appliedInvoiceSpendingLimitFees\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"feeAmount\": 0,\n \"feeAmountInCredits\": 0,\n \"feeAmountInBaseCurrency\": 0\n }\n ],\n \"appliedCommitments\": [\n {\n \"commitmentId\": \"\",\n \"obligationId\": \"\",\n \"obligationName\": \"\",\n \"feeAmount\": 0,\n \"feeInCredits\": 0,\n \"feeInBaseCurrency\": 0\n }\n ],\n \"itemSubscriptionDetails\": [\n {\n \"productItemId\": \"\",\n \"variantSubscriptionDetails\": [\n {\n \"groupInfo\": {\n \"gi\": \"\"\n },\n \"hourlyUsage\": [\n {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"subscriptionUnits\": 0,\n \"overageUnits\": 0\n }\n ]\n }\n ]\n }\n ],\n \"totalBill\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"totalPrice\": 0,\n \"itemPrice\": 0,\n \"fixPrice\": 0,\n \"invoiceBasedFees\": 0,\n \"invoiceSpendingLimitFees\": 0,\n \"commitmentsFees\": 0,\n \"prepaid\": 0,\n \"totalDiscount\": 0,\n \"totalPriceBeforeDiscount\": 0,\n \"totalPriceBeforePrepaid\": 0,\n \"totalPriceBeforeCommitments\": 0,\n \"totalPriceBeforeSalesTax\": 0,\n \"discountableFixPrice\": 0,\n \"discountableBasePrice\": 0,\n \"prepayableFixPrice\": 0,\n \"prepayableNotDiscountableFees\": 0,\n \"prepayableCommitmentsFees\": 0,\n \"totalPrepayablePrice\": 0\n },\n \"invoicePriceStatus\": \"\",\n \"creditUnit\": {\n \"id\": \"\",\n \"shortName\": \"\",\n \"name\": \"\",\n \"ratioToCurrency\": 0,\n \"description\": \"\",\n \"active\": false,\n \"lastUpdateTimeInMillis\": \"\"\n },\n \"paymentStatus\": \"\",\n \"paymentCreatedInSeconds\": \"\",\n \"externalSystemStatus\": \"\",\n \"invoiceBillInBaseCurrency\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"totalPrice\": 0,\n \"itemPrice\": 0,\n \"fixPrice\": 0,\n \"invoiceBasedFees\": 0,\n \"invoiceSpendingLimitFees\": 0,\n \"commitmentsFees\": 0,\n \"prepaid\": 0,\n \"totalDiscount\": 0,\n \"totalPriceBeforeDiscount\": 0,\n \"totalPriceBeforePrepaid\": 0,\n \"totalPriceBeforeCommitments\": 0,\n \"totalPriceBeforeSalesTax\": 0,\n \"discountableFixPrice\": 0,\n \"discountableBasePrice\": 0,\n \"prepayableFixPrice\": 0,\n \"prepayableNotDiscountableFees\": 0,\n \"prepayableCommitmentsFees\": 0,\n \"totalPrepayablePrice\": 0\n },\n \"invoiceBillInCredits\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"totalPrice\": 0,\n \"itemPrice\": 0,\n \"fixPrice\": 0,\n \"invoiceBasedFees\": 0,\n \"invoiceSpendingLimitFees\": 0,\n \"commitmentsFees\": 0,\n \"prepaid\": 0,\n \"totalDiscount\": 0,\n \"totalPriceBeforeDiscount\": 0,\n \"totalPriceBeforePrepaid\": 0,\n \"totalPriceBeforeCommitments\": 0,\n \"totalPriceBeforeSalesTax\": 0,\n \"discountableFixPrice\": 0,\n \"discountableBasePrice\": 0,\n \"prepayableFixPrice\": 0,\n \"prepayableNotDiscountableFees\": 0,\n \"prepayableCommitmentsFees\": 0,\n \"totalPrepayablePrice\": 0\n },\n \"prepaidPriceUsedBaseCurrency\": 0,\n \"prepaidPriceUsed\": 0,\n \"availablePrepaidLeft\": 0,\n \"availablePrepaidLeftBaseCurrency\": 0,\n \"prepaidUsageUsed\": 0,\n \"availablePrepaidUsageLeft\": 0,\n \"availablePrepaidLeftInCredits\": 0,\n \"invoiceSalesTax\": {\n \"totalTaxAmount\": 0,\n \"totalTaxableAmount\": 0,\n \"totalExemptAmount\": 0,\n \"combinedTaxRate\": 0,\n \"hasNexus\": false,\n \"taxCode\": \"\"\n },\n \"availablePayAsYouGoMoney\": 0,\n \"availablePayAsYouGoMoneyInBaseCurrency\": 0,\n \"availablePayAsYouGoMoneyInCredits\": 0,\n \"paymentCurrencyInfo\": {\n \"basePlanCurrency\": \"USD\",\n \"paymentCurrency\": \"USD\",\n \"exchangeRate\": 0\n },\n \"paymentMethod\": {\n \"methodType\": \"\",\n \"last4\": \"\",\n \"brand\": \"\"\n },\n \"messages\": [\n {\n \"level\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"invoiceStartTime\": \"\",\n \"invoiceEndTime\": \"\",\n \"voided\": false\n }\n ]\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }