@flexprice/sdk 2.1.20 → 2.1.24

package/docs/sdk/models/invoice-line-item-response.md

@@ -10,41 +10,42 @@ let value: InvoiceLineItemResponse = {};
 
 ## Fields
 
-| Field                                                                                                                                                                              | Type                                                                                                                                                                               | Required                                                                                                                                                                           | Description                                                                                                                                                                        |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `adjustedEntitlementQuantity`                                                                                                                                                      | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | adjusted_entitlement_quantity is the entitlement-covered portion deducted from raw usage.<br/>Nil when no entitlement was applied. Raw usage = Quantity + AdjustedEntitlementQuantity. |
-| `amount`                                                                                                                                                                           | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `commitmentInfo`                                                                                                                                                                   | [models.CommitmentInfo](../../sdk/models/commitment-info.md)                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `createdAt`                                                                                                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                      | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `createdBy`                                                                                                                                                                        | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `currency`                                                                                                                                                                         | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `customerId`                                                                                                                                                                       | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `displayName`                                                                                                                                                                      | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `entityId`                                                                                                                                                                         | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `entityType`                                                                                                                                                                       | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `environmentId`                                                                                                                                                                    | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `id`                                                                                                                                                                               | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `invoiceId`                                                                                                                                                                        | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `invoiceLevelDiscount`                                                                                                                                                             | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice.                                                                        |
-| `lineItemDiscount`                                                                                                                                                                 | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | line_item_discount is the discount amount in invoice currency applied directly to this line item.                                                                                  |
-| `metadata`                                                                                                                                                                         | Record<string, *string*>                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `meterDisplayName`                                                                                                                                                                 | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `meterId`                                                                                                                                                                          | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `periodEnd`                                                                                                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                      | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `periodStart`                                                                                                                                                                      | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                      | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `planDisplayName`                                                                                                                                                                  | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `prepaidCreditsApplied`                                                                                                                                                            | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application.                                                          |
-| `priceId`                                                                                                                                                                          | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `priceType`                                                                                                                                                                        | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `priceUnit`                                                                                                                                                                        | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `priceUnitAmount`                                                                                                                                                                  | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `priceUnitId`                                                                                                                                                                      | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `quantity`                                                                                                                                                                         | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `status`                                                                                                                                                                           | [models.Status](../../sdk/models/status.md)                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `subscriptionId`                                                                                                                                                                   | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `subscriptionLineItemId`                                                                                                                                                           | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | sub_line_item_id links this invoice line item to the subscription_line_item that generated it.                                                                                     |
-| `tenantId`                                                                                                                                                                         | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `updatedAt`                                                                                                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                      | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `updatedBy`                                                                                                                                                                        | *string*                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                 | N/A                                                                                                                                                                                |
-| `usageAnalytics`                                                                                                                                                                   | [models.SourceUsageItem](../../sdk/models/source-usage-item.md)[]                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                 | usage_analytics contains usage analytics for this line item (legacy - grouped by source)                                                                                           |
-| `usageBreakdown`                                                                                                                                                                   | [models.UsageBreakdownItem](../../sdk/models/usage-breakdown-item.md)[]                                                                                                            | :heavy_minus_sign:                                                                                                                                                                 | usage_breakdown contains flexible usage breakdown for this line item (supports any grouping)                                                                                       |
+| Field                                                                                                                                                                                                         | Type                                                                                                                                                                                                          | Required                                                                                                                                                                                                      | Description                                                                                                                                                                                                   |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `adjustedEntitlementQuantity`                                                                                                                                                                                 | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | adjusted_entitlement_quantity is the entitlement-covered portion deducted from raw usage.<br/>Nil when no entitlement was applied. Raw usage = Quantity + AdjustedEntitlementQuantity.                        |
+| `amount`                                                                                                                                                                                                      | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `commitmentInfo`                                                                                                                                                                                              | [models.CommitmentInfo](../../sdk/models/commitment-info.md)                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `createdAt`                                                                                                                                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `createdBy`                                                                                                                                                                                                   | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `currency`                                                                                                                                                                                                    | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `customerId`                                                                                                                                                                                                  | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `displayName`                                                                                                                                                                                                 | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `entityId`                                                                                                                                                                                                    | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `entityType`                                                                                                                                                                                                  | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `environmentId`                                                                                                                                                                                               | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `id`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `invoiceId`                                                                                                                                                                                                   | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `invoiceLevelDiscount`                                                                                                                                                                                        | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice.                                                                                                   |
+| `lineItemDiscount`                                                                                                                                                                                            | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | line_item_discount is the discount amount in invoice currency applied directly to this line item.                                                                                                             |
+| `metadata`                                                                                                                                                                                                    | Record<string, *string*>                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `meterDisplayName`                                                                                                                                                                                            | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `meterId`                                                                                                                                                                                                     | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `parentLineItemId`                                                                                                                                                                                            | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | parent_line_item_id links this line item to the line item it replaced, if it was created by editing<br/>an existing line item. Forms a linked-list chain across edits; nil for line items that were never edited. |
+| `periodEnd`                                                                                                                                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `periodStart`                                                                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `planDisplayName`                                                                                                                                                                                             | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `prepaidCreditsApplied`                                                                                                                                                                                       | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application.                                                                                     |
+| `priceId`                                                                                                                                                                                                     | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `priceType`                                                                                                                                                                                                   | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `priceUnit`                                                                                                                                                                                                   | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `priceUnitAmount`                                                                                                                                                                                             | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `priceUnitId`                                                                                                                                                                                                 | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `quantity`                                                                                                                                                                                                    | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `status`                                                                                                                                                                                                      | [models.Status](../../sdk/models/status.md)                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `subscriptionId`                                                                                                                                                                                              | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `subscriptionLineItemId`                                                                                                                                                                                      | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | sub_line_item_id links this invoice line item to the subscription_line_item that generated it.                                                                                                                |
+| `tenantId`                                                                                                                                                                                                    | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `updatedAt`                                                                                                                                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `updatedBy`                                                                                                                                                                                                   | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `usageAnalytics`                                                                                                                                                                                              | [models.SourceUsageItem](../../sdk/models/source-usage-item.md)[]                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                            | usage_analytics contains usage analytics for this line item (legacy - grouped by source)                                                                                                                      |
+| `usageBreakdown`                                                                                                                                                                                              | [models.UsageBreakdownItem](../../sdk/models/usage-breakdown-item.md)[]                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                            | usage_breakdown contains flexible usage breakdown for this line item (supports any grouping)                                                                                                                  |