class Stripe::Invoiceitem

• Stripe::Invoiceitem
• Reference
• Object

Overview

Invoice Items represent the component lines of an invoice. An invoice item is added to an invoice by creating or updating it with an #invoice field, at which point it will be included as an invoice line item within invoice.lines. Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a subscription. Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals. Related guides: Integrate with the Invoicing API, Subscription Invoices.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [invoiceitem]."

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_SUBSCRIPTION_ITEM = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("invoiceitem")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, customer : Stripe::InvoiceitemCustomer | Nil = nil, date : Int64 | Nil = nil, description : String | Nil = nil, discountable : Bool | Nil = nil, discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil = nil, id : String | Nil = nil, invoice : Stripe::InvoiceitemInvoice | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, period : Stripe::InvoiceLineItemPeriod | Nil = nil, plan : Stripe::InvoiceitemPlan | Nil = nil, price : Stripe::InvoiceitemPrice | Nil = nil, proration : Bool | Nil = nil, quantity : Int64 | Nil = nil, subscription : Stripe::InvoiceitemSubscription | Nil = nil, tax_rates : Array(Stripe::TaxRate) | Nil = nil, test_clock : Stripe::InvoiceitemTestClock | Nil = nil, unit_amount : Int64 | Nil = nil, unit_amount_decimal : BigDecimal | Nil = nil, subscription_item : String | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance Method Summary

• #==(other : self)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #amount : Int64 | Nil
• #amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer : Stripe::InvoiceitemCustomer | Nil
• #customer=(new_value : Stripe::InvoiceitemCustomer | Nil)

  Custom attribute writer method checking allowed values (enum).

• #date : Int64 | Nil
• #date=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #description : String | Nil
• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #discountable : Bool | Nil
• #discountable=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil
• #discounts=(new_value : Array(Stripe::InvoiceitemDiscountsInner) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #invoice : Stripe::InvoiceitemInvoice | Nil
• #invoice=(new_value : Stripe::InvoiceitemInvoice | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #period : Stripe::InvoiceLineItemPeriod | Nil
• #period=(new_value : Stripe::InvoiceLineItemPeriod | Nil)

  Custom attribute writer method checking allowed values (enum).

• #plan : Stripe::InvoiceitemPlan | Nil
• #plan=(new_value : Stripe::InvoiceitemPlan | Nil)

  Custom attribute writer method checking allowed values (enum).

• #price : Stripe::InvoiceitemPrice | Nil
• #price=(new_value : Stripe::InvoiceitemPrice | Nil)

  Custom attribute writer method checking allowed values (enum).

• #proration : Bool | Nil
• #proration=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #quantity : Int64 | Nil
• #quantity=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #subscription : Stripe::InvoiceitemSubscription | Nil
• #subscription=(new_value : Stripe::InvoiceitemSubscription | Nil)

  Custom attribute writer method checking allowed values (enum).

• #subscription_item : String | Nil
• #subscription_item=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tax_rates : Array(Stripe::TaxRate) | Nil
• #tax_rates=(new_value : Array(Stripe::TaxRate) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #test_clock : Stripe::InvoiceitemTestClock | Nil
• #test_clock=(new_value : Stripe::InvoiceitemTestClock | Nil)

  Custom attribute writer method checking allowed values (enum).

• #unit_amount : Int64 | Nil
• #unit_amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #unit_amount_decimal : BigDecimal | Nil
• #unit_amount_decimal=(new_value : BigDecimal | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

  Check to see if the all the properties in the model are valid @return true if the model is valid

Constructor Detail

Instance Method Detail