1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
// ======================================
// This file was automatically generated.
// ======================================
use serde::{Deserialize, Serialize};
use crate::ids::InvoiceLineItemId;
use crate::params::{Expandable, Metadata, Object};
use crate::resources::{
Currency, Discount, InvoiceItem, Period, Plan, Price, Subscription, SubscriptionItem, TaxRate,
};
/// The resource representing a Stripe "InvoiceLineItem".
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct InvoiceLineItem {
/// Unique identifier for the object.
pub id: InvoiceLineItemId,
/// The amount, in cents (or local equivalent).
pub amount: i64,
/// The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.
pub amount_excluding_tax: Option<i64>,
/// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
///
/// Must be a [supported currency](https://stripe.com/docs/currencies).
pub currency: Currency,
/// An arbitrary string attached to the object.
///
/// Often useful for displaying to users.
pub description: Option<String>,
/// The amount of discount calculated per discount for this line item.
pub discount_amounts: Option<Vec<DiscountsResourceDiscountAmount>>,
/// If true, discounts will apply to this line item.
///
/// Always false for prorations.
pub discountable: bool,
/// The discounts applied to the invoice line item.
///
/// Line item discounts are applied before invoice discounts.
/// Use `expand[]=discounts` to expand each discount.
pub discounts: Option<Vec<Expandable<Discount>>>,
/// The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.
#[serde(skip_serializing_if = "Option::is_none")]
pub invoice_item: Option<Expandable<InvoiceItem>>,
/// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
pub livemode: bool,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
/// Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created.
pub metadata: Metadata,
pub period: Option<Period>,
/// The plan of the subscription, if the line item is a subscription or a proration.
pub plan: Option<Plan>,
/// The price of the line item.
pub price: Option<Price>,
/// Whether this is a proration.
pub proration: bool,
/// Additional details for proration line items.
pub proration_details: Option<InvoicesResourceLineItemsProrationDetails>,
/// The quantity of the subscription, if the line item is a subscription or a proration.
pub quantity: Option<u64>,
/// The subscription that the invoice item pertains to, if any.
pub subscription: Option<Expandable<Subscription>>,
/// The subscription item that generated this line item.
///
/// Left empty if the line item is not an explicit result of a subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub subscription_item: Option<Expandable<SubscriptionItem>>,
/// The amount of tax calculated per tax rate for this line item.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_amounts: Option<Vec<TaxAmount>>,
/// The tax rates which apply to the line item.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_rates: Option<Vec<TaxRate>>,
/// A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.
#[serde(rename = "type")]
pub type_: InvoiceLineItemType,
/// The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.
pub unit_amount_excluding_tax: Option<String>,
}
impl Object for InvoiceLineItem {
type Id = InvoiceLineItemId;
fn id(&self) -> Self::Id {
self.id.clone()
}
fn object(&self) -> &'static str {
"line_item"
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct DiscountsResourceDiscountAmount {
/// The amount, in cents (or local equivalent), of the discount.
pub amount: i64,
/// The discount that was applied to get this discount amount.
pub discount: Expandable<Discount>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct TaxAmount {
/// The amount, in cents (or local equivalent), of the tax.
pub amount: i64,
/// Whether this tax amount is inclusive or exclusive.
pub inclusive: bool,
/// The tax rate that was applied to get this tax amount.
pub tax_rate: Expandable<TaxRate>,
/// The reasoning behind this tax, for example, if the product is tax exempt.
///
/// The possible values for this field may be extended as new tax rules are supported.
pub taxability_reason: Option<TaxAmountTaxabilityReason>,
/// The amount on which tax is calculated, in cents (or local equivalent).
pub taxable_amount: Option<i64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct InvoicesResourceLineItemsProrationDetails {
/// For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
pub credited_items: Option<InvoicesResourceLineItemsCreditedItems>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct InvoicesResourceLineItemsCreditedItems {
/// Invoice containing the credited invoice line items.
pub invoice: String,
/// Credited invoice line items.
pub invoice_line_items: Vec<String>,
}
/// An enum representing the possible values of an `InvoiceLineItem`'s `type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum InvoiceLineItemType {
#[serde(rename = "invoiceitem")]
InvoiceItem,
Subscription,
}
impl InvoiceLineItemType {
pub fn as_str(self) -> &'static str {
match self {
InvoiceLineItemType::InvoiceItem => "invoiceitem",
InvoiceLineItemType::Subscription => "subscription",
}
}
}
impl AsRef<str> for InvoiceLineItemType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for InvoiceLineItemType {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for InvoiceLineItemType {
fn default() -> Self {
Self::InvoiceItem
}
}
/// An enum representing the possible values of an `TaxAmount`'s `taxability_reason` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum TaxAmountTaxabilityReason {
CustomerExempt,
NotCollecting,
NotSubjectToTax,
NotSupported,
PortionProductExempt,
PortionReducedRated,
PortionStandardRated,
ProductExempt,
ProductExemptHoliday,
ProportionallyRated,
ReducedRated,
ReverseCharge,
StandardRated,
TaxableBasisReduced,
ZeroRated,
}
impl TaxAmountTaxabilityReason {
pub fn as_str(self) -> &'static str {
match self {
TaxAmountTaxabilityReason::CustomerExempt => "customer_exempt",
TaxAmountTaxabilityReason::NotCollecting => "not_collecting",
TaxAmountTaxabilityReason::NotSubjectToTax => "not_subject_to_tax",
TaxAmountTaxabilityReason::NotSupported => "not_supported",
TaxAmountTaxabilityReason::PortionProductExempt => "portion_product_exempt",
TaxAmountTaxabilityReason::PortionReducedRated => "portion_reduced_rated",
TaxAmountTaxabilityReason::PortionStandardRated => "portion_standard_rated",
TaxAmountTaxabilityReason::ProductExempt => "product_exempt",
TaxAmountTaxabilityReason::ProductExemptHoliday => "product_exempt_holiday",
TaxAmountTaxabilityReason::ProportionallyRated => "proportionally_rated",
TaxAmountTaxabilityReason::ReducedRated => "reduced_rated",
TaxAmountTaxabilityReason::ReverseCharge => "reverse_charge",
TaxAmountTaxabilityReason::StandardRated => "standard_rated",
TaxAmountTaxabilityReason::TaxableBasisReduced => "taxable_basis_reduced",
TaxAmountTaxabilityReason::ZeroRated => "zero_rated",
}
}
}
impl AsRef<str> for TaxAmountTaxabilityReason {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for TaxAmountTaxabilityReason {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for TaxAmountTaxabilityReason {
fn default() -> Self {
Self::CustomerExempt
}
}