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

Latest commit

 

History

History
30 lines (24 loc) · 1.89 KB

FeeObjectItem.md

File metadata and controls

30 lines (24 loc) · 1.89 KB

LagoAPI::FeeObjectItem

Properties

Name Type Description Notes
type String 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`.
invoice_display_name 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]
group_invoice_display_name 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]
lago_item_id String 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`.
item_type String The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction` or `Subscription`.

Example

require 'lago_ruby'

instance = LagoAPI::FeeObjectItem.new(
  type: subscription,
  code: startup,
  name: Startup,
  invoice_display_name: Setup Fee (SF1),
  group_invoice_display_name: Transactions - ACH,
  lago_item_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
  item_type: Subscription
)