Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Latest commit

 

History

History
42 lines (26 loc) · 2.07 KB

FeeObjectItem.md

File metadata and controls

42 lines (26 loc) · 2.07 KB

FeeObjectItem

Item attached to the fee

Properties

Name Type Description Notes
type TypeEnum The fee type. Possible values are `add-on`, `charge`, `credit` or `subscription`.
code String The code of the fee item. It can be the code of the `add-o`n, the code of the `charge`, the code of the `credit` or the code of the `subscription`.
name String The name of the fee item. It can be the name of the `add-on`, the name of the `charge`, the name of the `credit` or the name of the `subscription`.
invoiceDisplayName String Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. [optional]
groupInvoiceDisplayName String Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. [optional]
lagoItemId UUID Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the identifier of the `charge`, the identifier of the `credit` or the identifier of the `subscription`.
itemType ItemTypeEnum The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction` or `Subscription`.

Enum: TypeEnum

Name Value
CHARGE "charge"
ADD_ON "add_on"
SUBSCRIPTION "subscription"
CREDIT "credit"

Enum: ItemTypeEnum

Name Value
ADDON "AddOn"
BILLABLEMETRIC "BillableMetric"
SUBSCRIPTION "Subscription"
WALLETTRANSACTION "WalletTransaction"