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

Latest commit

 

History

History
35 lines (23 loc) · 2.66 KB

PlanCreateInputPlanChargesInner.md

File metadata and controls

35 lines (23 loc) · 2.66 KB
Raw

PlanCreateInputPlanChargesInner

Properties

Name Type Description Notes
billableMetricId UUID Unique identifier of the billable metric created by Lago. [optional]
chargeModel ChargeModelEnum Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`. [optional]
payInAdvance 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]
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]
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]
minAmountCents 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]
groupProperties List<PlanCreateInputPlanChargesInnerGroupPropertiesInner> All charge information, sorted by groups. [optional]
taxCodes List<String> List of unique code used to identify the taxes. [optional]

Enum: ChargeModelEnum

Name Value
STANDARD "standard"
GRADUATED "graduated"
GRADUATED_PERCENTAGE "graduated_percentage"
PACKAGE "package"
PERCENTAGE "percentage"
VOLUME "volume"