PlanCreateInputPlanChargesInner.md

LagoAPI::PlanCreateInputPlanChargesInner

Properties

Name	Type	Description	Notes
billable_metric_id	String	Unique identifier of the billable metric created by Lago.	[optional]
charge_model	String	Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`.	[optional]
pay_in_advance	Boolean	This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.	[optional]
invoiceable	Boolean	This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.	[optional]
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]
prorated	Boolean	Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully. - If set to `true`, the charge is prorated based on the remaining days in the current billing period. - If set to `false`, the charge is billed in full. - If not defined in the request, default value is `false`.	[optional]
min_amount_cents	Integer	The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.	[optional]
properties	ChargeObjectProperties		[optional]
group_properties	Array<PlanCreateInputPlanChargesInnerGroupPropertiesInner>	All charge information, sorted by groups.	[optional]
tax_codes	Array<String>	List of unique code used to identify the taxes.	[optional]

Example

require 'lago_ruby'

instance = LagoAPI::PlanCreateInputPlanChargesInner.new(
  billable_metric_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
  charge_model: standard,
  pay_in_advance: false,
  invoiceable: true,
  invoice_display_name: Setup,
  prorated: false,
  min_amount_cents: 0,
  properties: null,
  group_properties: null,
  tax_codes: ["french_standard_vat"]
)