ChargeObjectProperties.md

LagoAPI::ChargeObjectProperties

Properties

Name	Type	Description	Notes
graduated_ranges	Array<ChargePropertiesGraduatedRangesInner>	Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.	[optional]
graduated_percentage_ranges	Array<ChargePropertiesGraduatedPercentageRangesInner>	Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.	[optional]
amount	String	- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value. - The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.	[optional]
free_units	Integer	The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.	[optional]
package_size	Integer	The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.	[optional]
rate	String	The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.	[optional]
fixed_amount	String	The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.	[optional]
free_units_per_events	Integer	The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.	[optional]
free_units_per_total_aggregation	String	The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.	[optional]
per_transaction_max_amount	String	Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.	[optional]
per_transaction_min_amount	String	Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.	[optional]
volume_ranges	Array<ChargePropertiesVolumeRangesInner>	Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.	[optional]

Example

require 'lago_ruby'

instance = LagoAPI::ChargeObjectProperties.new(
  graduated_ranges: null,
  graduated_percentage_ranges: null,
  amount: 30,
  free_units: 100,
  package_size: 1000,
  rate: 1,
  fixed_amount: 0.5,
  free_units_per_events: 5,
  free_units_per_total_aggregation: 500,
  per_transaction_max_amount: 3.75,
  per_transaction_min_amount: 1.75,
  volume_ranges: null
)