class Stripe::Invoice

• Stripe::Invoice
• Reference
• Object

Overview

Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain invoice items, and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, when automatic, does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice. If your invoice is configured to be billed by sending an email, then based on your email settings, Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice. Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe's minimum allowed charge per currency, the invoice is automatically marked paid, and we add the amount due to the customer's credit balance which is applied to the next invoice. More details on the customer's credit balance are here. Related guide: Send invoices to customers

Included Modules

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

Defined in:

Constant Summary

ERROR_MESSAGE_FOR_BILLING_REASON = "invalid value for \"billing_reason\", must be one of [automatic_pending_invoice_item_invoice, manual, quote_accept, subscription, subscription_create, subscription_cycle, subscription_threshold, subscription_update, upcoming]."

ERROR_MESSAGE_FOR_COLLECTION_METHOD = "invalid value for \"collection_method\", must be one of [charge_automatically, send_invoice]."

ERROR_MESSAGE_FOR_CUSTOMER_TAX_EXEMPT = "invalid value for \"customer_tax_exempt\", must be one of [exempt, none, reverse]."

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

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [draft, open, paid, uncollectible, void]."

MAX_LENGTH_FOR_ACCOUNT_COUNTRY = 5000

MAX_LENGTH_FOR_ACCOUNT_NAME = 5000

MAX_LENGTH_FOR_CUSTOMER_EMAIL = 5000

MAX_LENGTH_FOR_CUSTOMER_NAME = 5000

MAX_LENGTH_FOR_CUSTOMER_PHONE = 5000

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_FOOTER = 5000

MAX_LENGTH_FOR_HOSTED_INVOICE_URL = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_INVOICE_PDF = 5000

MAX_LENGTH_FOR_NUMBER = 5000

MAX_LENGTH_FOR_RECEIPT_NUMBER = 5000

MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR = 5000

VALID_VALUES_FOR_BILLING_REASON = String.static_array("automatic_pending_invoice_item_invoice", "manual", "quote_accept", "subscription", "subscription_create", "subscription_cycle", "subscription_threshold", "subscription_update", "upcoming")

VALID_VALUES_FOR_COLLECTION_METHOD = String.static_array("charge_automatically", "send_invoice")

VALID_VALUES_FOR_CUSTOMER_TAX_EXEMPT = String.static_array("exempt", "none", "reverse")

VALID_VALUES_FOR_OBJECT = String.static_array("invoice")

VALID_VALUES_FOR_STATUS = String.static_array("draft", "open", "paid", "uncollectible", "void")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, account_country : String | Nil = nil, account_name : String | Nil = nil, account_tax_ids : Array(Stripe::InvoiceAccountTaxIdsInner) | Nil = nil, amount_due : Int64 | Nil = nil, amount_paid : Int64 | Nil = nil, amount_remaining : Int64 | Nil = nil, amount_shipping : Int64 | Nil = nil, application : Stripe::InvoiceApplication | Nil = nil, application_fee_amount : Int64 | Nil = nil, attempt_count : Int64 | Nil = nil, attempted : Bool | Nil = nil, automatic_tax : Stripe::AutomaticTax | Nil = nil, billing_reason : String | Nil = nil, charge : Stripe::InvoiceCharge | Nil = nil, collection_method : String | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, custom_fields : Array(Stripe::InvoiceSettingCustomField) | Nil = nil, customer : Stripe::InvoiceCustomer | Nil = nil, customer_address : Stripe::InvoiceCustomerAddress | Nil = nil, customer_email : String | Nil = nil, customer_name : String | Nil = nil, customer_phone : String | Nil = nil, customer_shipping : Stripe::InvoiceCustomerShipping | Nil = nil, customer_tax_exempt : String | Nil = nil, default_payment_method : Stripe::InvoiceDefaultPaymentMethod | Nil = nil, default_source : Stripe::InvoiceDefaultSource | Nil = nil, default_tax_rates : Array(Stripe::TaxRate) | Nil = nil, description : String | Nil = nil, discount : Stripe::InvoiceDiscount | Nil = nil, discounts : Array(Stripe::InvoiceDiscountsInner) | Nil = nil, due_date : Int64 | Nil = nil, effective_at : Int64 | Nil = nil, ending_balance : Int64 | Nil = nil, footer : String | Nil = nil, from_invoice : Stripe::InvoiceFromInvoice | Nil = nil, issuer : Stripe::ConnectAccountReference | Nil = nil, last_finalization_error : Stripe::InvoiceLastFinalizationError | Nil = nil, latest_revision : Stripe::InvoiceLatestRevision | Nil = nil, lines : Stripe::InvoiceLinesList | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, next_payment_attempt : Int64 | Nil = nil, number : String | Nil = nil, object : String | Nil = nil, on_behalf_of : Stripe::InvoiceOnBehalfOf | Nil = nil, paid : Bool | Nil = nil, paid_out_of_band : Bool | Nil = nil, payment_intent : Stripe::InvoicePaymentIntent | Nil = nil, payment_settings : Stripe::InvoicesPaymentSettings | Nil = nil, period_end : Int64 | Nil = nil, period_start : Int64 | Nil = nil, post_payment_credit_notes_amount : Int64 | Nil = nil, pre_payment_credit_notes_amount : Int64 | Nil = nil, quote : Stripe::InvoiceQuote | Nil = nil, receipt_number : String | Nil = nil, rendering : Stripe::InvoiceRendering | Nil = nil, shipping_cost : Stripe::InvoiceShippingCost | Nil = nil, shipping_details : Stripe::InvoiceShippingDetails | Nil = nil, starting_balance : Int64 | Nil = nil, statement_descriptor : String | Nil = nil, status : String | Nil = nil, status_transitions : Stripe::InvoicesResourceStatusTransitions | Nil = nil, subscription : Stripe::InvoiceSubscription | Nil = nil, subscription_details : Stripe::InvoiceSubscriptionDetails | Nil = nil, subtotal : Int64 | Nil = nil, subtotal_excluding_tax : Int64 | Nil = nil, tax : Int64 | Nil = nil, test_clock : Stripe::InvoiceTestClock | Nil = nil, total : Int64 | Nil = nil, total_discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil = nil, total_excluding_tax : Int64 | Nil = nil, total_tax_amounts : Array(Stripe::InvoiceTaxAmount) | Nil = nil, transfer_data : Stripe::InvoiceTransferData1 | Nil = nil, webhooks_delivered_at : Int64 | Nil = nil, auto_advance : Bool | Nil = nil, customer_tax_ids : Array(Stripe::InvoicesResourceInvoiceTaxId) | Nil = nil, hosted_invoice_url : String | Nil = nil, id : String | Nil = nil, invoice_pdf : String | Nil = nil, subscription_proration_date : Int64 | Nil = nil, threshold_reason : Stripe::InvoiceThresholdReason | 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.

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #account_tax_ids : Array(Stripe::InvoiceAccountTaxIdsInner) | Nil
• #account_tax_ids=(new_value : Array(Stripe::InvoiceAccountTaxIdsInner) | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #application : Stripe::InvoiceApplication | Nil
• #application=(new_value : Stripe::InvoiceApplication | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #automatic_tax : Stripe::AutomaticTax | Nil
• #automatic_tax=(new_value : Stripe::AutomaticTax | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #charge : Stripe::InvoiceCharge | Nil
• #charge=(new_value : Stripe::InvoiceCharge | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(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).

• #custom_fields : Array(Stripe::InvoiceSettingCustomField) | Nil
• #custom_fields=(new_value : Array(Stripe::InvoiceSettingCustomField) | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #customer_address : Stripe::InvoiceCustomerAddress | Nil
• #customer_address=(new_value : Stripe::InvoiceCustomerAddress | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #customer_shipping : Stripe::InvoiceCustomerShipping | Nil
• #customer_shipping=(new_value : Stripe::InvoiceCustomerShipping | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #customer_tax_ids : Array(Stripe::InvoicesResourceInvoiceTaxId) | Nil
• #customer_tax_ids=(new_value : Array(Stripe::InvoicesResourceInvoiceTaxId) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer_tax_ids_present=(customer_tax_ids_present : Bool)
• #customer_tax_ids_present? : Bool
• #default_payment_method : Stripe::InvoiceDefaultPaymentMethod | Nil
• #default_payment_method=(new_value : Stripe::InvoiceDefaultPaymentMethod | Nil)

  Custom attribute writer method checking allowed values (enum).

• #default_source : Stripe::InvoiceDefaultSource | Nil
• #default_source=(new_value : Stripe::InvoiceDefaultSource | Nil)

  Custom attribute writer method checking allowed values (enum).

• #default_tax_rates : Array(Stripe::TaxRate) | Nil
• #default_tax_rates=(new_value : Array(Stripe::TaxRate) | 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).

• #discount : Stripe::InvoiceDiscount | Nil
• #discount=(new_value : Stripe::InvoiceDiscount | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #from_invoice : Stripe::InvoiceFromInvoice | Nil
• #from_invoice=(new_value : Stripe::InvoiceFromInvoice | 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.

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

  Custom attribute writer method checking allowed values (enum).

• #hosted_invoice_url_present=(hosted_invoice_url_present : Bool)
• #hosted_invoice_url_present? : Bool
• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #invoice_pdf_present=(invoice_pdf_present : Bool)
• #invoice_pdf_present? : Bool
• #issuer : Stripe::ConnectAccountReference | Nil
• #issuer=(new_value : Stripe::ConnectAccountReference | Nil)

  Custom attribute writer method checking allowed values (enum).

• #last_finalization_error : Stripe::InvoiceLastFinalizationError | Nil
• #last_finalization_error=(new_value : Stripe::InvoiceLastFinalizationError | Nil)

  Custom attribute writer method checking allowed values (enum).

• #latest_revision : Stripe::InvoiceLatestRevision | Nil
• #latest_revision=(new_value : Stripe::InvoiceLatestRevision | Nil)

  Custom attribute writer method checking allowed values (enum).

• #lines : Stripe::InvoiceLinesList | Nil
• #lines=(new_value : Stripe::InvoiceLinesList | 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).

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

  Custom attribute writer method checking allowed values (enum).

• #number : String | Nil
• #number=(new_value : 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).

• #on_behalf_of : Stripe::InvoiceOnBehalfOf | Nil
• #on_behalf_of=(new_value : Stripe::InvoiceOnBehalfOf | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #payment_intent : Stripe::InvoicePaymentIntent | Nil
• #payment_intent=(new_value : Stripe::InvoicePaymentIntent | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_settings : Stripe::InvoicesPaymentSettings | Nil
• #payment_settings=(new_value : Stripe::InvoicesPaymentSettings | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #quote : Stripe::InvoiceQuote | Nil
• #quote=(new_value : Stripe::InvoiceQuote | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #rendering : Stripe::InvoiceRendering | Nil
• #rendering=(new_value : Stripe::InvoiceRendering | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shipping_cost : Stripe::InvoiceShippingCost | Nil
• #shipping_cost=(new_value : Stripe::InvoiceShippingCost | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shipping_details : Stripe::InvoiceShippingDetails | Nil
• #shipping_details=(new_value : Stripe::InvoiceShippingDetails | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #status_transitions : Stripe::InvoicesResourceStatusTransitions | Nil
• #status_transitions=(new_value : Stripe::InvoicesResourceStatusTransitions | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #subscription_details : Stripe::InvoiceSubscriptionDetails | Nil
• #subscription_details=(new_value : Stripe::InvoiceSubscriptionDetails | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #threshold_reason : Stripe::InvoiceThresholdReason | Nil
• #threshold_reason=(new_value : Stripe::InvoiceThresholdReason | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #total_discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil
• #total_discount_amounts=(new_value : Array(Stripe::DiscountsResourceDiscountAmount) | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #total_tax_amounts : Array(Stripe::InvoiceTaxAmount) | Nil
• #total_tax_amounts=(new_value : Array(Stripe::InvoiceTaxAmount) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transfer_data : Stripe::InvoiceTransferData1 | Nil
• #transfer_data=(new_value : Stripe::InvoiceTransferData1 | 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

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

  Custom attribute writer method checking allowed values (enum).

Constructor Detail

Instance Method Detail