class Stripe::CustomerBalanceTransactionInvoice

• Stripe::CustomerBalanceTransactionInvoice
• Reference
• Object

Overview

The ID of the invoice (if any) related to the transaction.

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::Address | Nil = nil, customer_email : String | Nil = nil, customer_name : String | Nil = nil, customer_phone : String | Nil = nil, customer_shipping : Stripe::Shipping | 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::Discount | 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::InvoicesResourceFromInvoice | Nil = nil, issuer : Stripe::ConnectAccountReference | Nil = nil, last_finalization_error : Stripe::ApiErrors | 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::InvoicesResourceInvoiceRendering | Nil = nil, shipping_cost : Stripe::InvoicesResourceShippingCost | Nil = nil, shipping_details : Stripe::Shipping | 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::SubscriptionDetailsData | 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::InvoiceTransferData | 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

Class Method Summary

• .openapi_any_of

  List of class defined in anyOf (OpenAPI v3)

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=(account_country : String | Nil)
• #account_name : String | Nil
• #account_name=(account_name : String | Nil)
• #account_tax_ids : Array(Stripe::InvoiceAccountTaxIdsInner) | Nil
• #account_tax_ids=(account_tax_ids : Array(Stripe::InvoiceAccountTaxIdsInner) | Nil)
• #amount_due : Int64 | Nil
• #amount_due=(amount_due : Int64 | Nil)
• #amount_paid : Int64 | Nil
• #amount_paid=(amount_paid : Int64 | Nil)
• #amount_remaining : Int64 | Nil
• #amount_remaining=(amount_remaining : Int64 | Nil)
• #amount_shipping : Int64 | Nil
• #amount_shipping=(amount_shipping : Int64 | Nil)
• #application : Stripe::InvoiceApplication | Nil
• #application=(application : Stripe::InvoiceApplication | Nil)
• #application_fee_amount : Int64 | Nil
• #application_fee_amount=(application_fee_amount : Int64 | Nil)
• #attempt_count : Int64 | Nil
• #attempt_count=(attempt_count : Int64 | Nil)
• #attempted : Bool | Nil
• #attempted=(attempted : Bool | Nil)
• #auto_advance : Bool | Nil
• #auto_advance=(auto_advance : Bool | Nil)
• #automatic_tax : Stripe::AutomaticTax | Nil
• #automatic_tax=(automatic_tax : Stripe::AutomaticTax | Nil)
• #billing_reason : String | Nil
• #billing_reason=(billing_reason : String | Nil)
• #charge : Stripe::InvoiceCharge | Nil
• #charge=(charge : Stripe::InvoiceCharge | Nil)
• #collection_method : String | Nil
• #collection_method=(collection_method : String | Nil)
• #created : Int64 | Nil
• #created=(created : Int64 | Nil)
• #currency : String | Nil
• #currency=(currency : String | Nil)
• #custom_fields : Array(Stripe::InvoiceSettingCustomField) | Nil
• #custom_fields=(custom_fields : Array(Stripe::InvoiceSettingCustomField) | Nil)
• #customer : Stripe::InvoiceCustomer | Nil
• #customer=(customer : Stripe::InvoiceCustomer | Nil)
• #customer_address : Stripe::Address | Nil
• #customer_address=(customer_address : Stripe::Address | Nil)
• #customer_email : String | Nil
• #customer_email=(customer_email : String | Nil)
• #customer_name : String | Nil
• #customer_name=(customer_name : String | Nil)
• #customer_phone : String | Nil
• #customer_phone=(customer_phone : String | Nil)
• #customer_shipping : Stripe::Shipping | Nil
• #customer_shipping=(customer_shipping : Stripe::Shipping | Nil)
• #customer_tax_exempt : String | Nil
• #customer_tax_exempt=(customer_tax_exempt : String | Nil)
• #customer_tax_ids : Array(Stripe::InvoicesResourceInvoiceTaxId) | Nil
• #customer_tax_ids=(customer_tax_ids : Array(Stripe::InvoicesResourceInvoiceTaxId) | Nil)
• #customer_tax_ids_present=(customer_tax_ids_present : Bool)
• #customer_tax_ids_present? : Bool
• #default_payment_method : Stripe::InvoiceDefaultPaymentMethod | Nil
• #default_payment_method=(default_payment_method : Stripe::InvoiceDefaultPaymentMethod | Nil)
• #default_source : Stripe::InvoiceDefaultSource | Nil
• #default_source=(default_source : Stripe::InvoiceDefaultSource | Nil)
• #default_tax_rates : Array(Stripe::TaxRate) | Nil
• #default_tax_rates=(default_tax_rates : Array(Stripe::TaxRate) | Nil)
• #description : String | Nil
• #description=(description : String | Nil)
• #discount : Stripe::Discount | Nil
• #discount=(discount : Stripe::Discount | Nil)
• #discounts : Array(Stripe::InvoiceDiscountsInner) | Nil
• #discounts=(discounts : Array(Stripe::InvoiceDiscountsInner) | Nil)
• #due_date : Int64 | Nil
• #due_date=(due_date : Int64 | Nil)
• #effective_at : Int64 | Nil
• #effective_at=(effective_at : Int64 | Nil)
• #ending_balance : Int64 | Nil
• #ending_balance=(ending_balance : Int64 | Nil)
• #footer : String | Nil
• #footer=(footer : String | Nil)
• #from_invoice : Stripe::InvoicesResourceFromInvoice | Nil
• #from_invoice=(from_invoice : Stripe::InvoicesResourceFromInvoice | Nil)
• #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=(hosted_invoice_url : String | Nil)
• #hosted_invoice_url_present=(hosted_invoice_url_present : Bool)
• #hosted_invoice_url_present? : Bool
• #id : String | Nil
• #id=(id : String | Nil)
• #invoice_pdf : String | Nil
• #invoice_pdf=(invoice_pdf : String | Nil)
• #invoice_pdf_present=(invoice_pdf_present : Bool)
• #invoice_pdf_present? : Bool
• #issuer : Stripe::ConnectAccountReference | Nil
• #issuer=(issuer : Stripe::ConnectAccountReference | Nil)
• #last_finalization_error : Stripe::ApiErrors | Nil
• #last_finalization_error=(last_finalization_error : Stripe::ApiErrors | Nil)
• #latest_revision : Stripe::InvoiceLatestRevision | Nil
• #latest_revision=(latest_revision : Stripe::InvoiceLatestRevision | Nil)
• #lines : Stripe::InvoiceLinesList | Nil
• #lines=(lines : Stripe::InvoiceLinesList | Nil)
• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(livemode : Bool | Nil)
• #metadata : Hash(String, String) | Nil
• #metadata=(metadata : Hash(String, String) | Nil)
• #next_payment_attempt : Int64 | Nil
• #next_payment_attempt=(next_payment_attempt : Int64 | Nil)
• #number : String | Nil
• #number=(number : String | Nil)
• #object : String | Nil
• #object=(object : String | Nil)
• #on_behalf_of : Stripe::InvoiceOnBehalfOf | Nil
• #on_behalf_of=(on_behalf_of : Stripe::InvoiceOnBehalfOf | Nil)
• #paid : Bool | Nil
• #paid=(paid : Bool | Nil)
• #paid_out_of_band : Bool | Nil
• #paid_out_of_band=(paid_out_of_band : Bool | Nil)
• #payment_intent : Stripe::InvoicePaymentIntent | Nil
• #payment_intent=(payment_intent : Stripe::InvoicePaymentIntent | Nil)
• #payment_settings : Stripe::InvoicesPaymentSettings | Nil
• #payment_settings=(payment_settings : Stripe::InvoicesPaymentSettings | Nil)
• #period_end : Int64 | Nil
• #period_end=(period_end : Int64 | Nil)
• #period_start : Int64 | Nil
• #period_start=(period_start : Int64 | Nil)
• #post_payment_credit_notes_amount : Int64 | Nil
• #post_payment_credit_notes_amount=(post_payment_credit_notes_amount : Int64 | Nil)
• #pre_payment_credit_notes_amount : Int64 | Nil
• #pre_payment_credit_notes_amount=(pre_payment_credit_notes_amount : Int64 | Nil)
• #quote : Stripe::InvoiceQuote | Nil
• #quote=(quote : Stripe::InvoiceQuote | Nil)
• #receipt_number : String | Nil
• #receipt_number=(receipt_number : String | Nil)
• #rendering : Stripe::InvoicesResourceInvoiceRendering | Nil
• #rendering=(rendering : Stripe::InvoicesResourceInvoiceRendering | Nil)
• #shipping_cost : Stripe::InvoicesResourceShippingCost | Nil
• #shipping_cost=(shipping_cost : Stripe::InvoicesResourceShippingCost | Nil)
• #shipping_details : Stripe::Shipping | Nil
• #shipping_details=(shipping_details : Stripe::Shipping | Nil)
• #starting_balance : Int64 | Nil
• #starting_balance=(starting_balance : Int64 | Nil)
• #statement_descriptor : String | Nil
• #statement_descriptor=(statement_descriptor : String | Nil)
• #status : String | Nil
• #status=(status : String | Nil)
• #status_transitions : Stripe::InvoicesResourceStatusTransitions | Nil
• #status_transitions=(status_transitions : Stripe::InvoicesResourceStatusTransitions | Nil)
• #subscription : Stripe::InvoiceSubscription | Nil
• #subscription=(subscription : Stripe::InvoiceSubscription | Nil)
• #subscription_details : Stripe::SubscriptionDetailsData | Nil
• #subscription_details=(subscription_details : Stripe::SubscriptionDetailsData | Nil)
• #subscription_proration_date : Int64 | Nil
• #subscription_proration_date=(subscription_proration_date : Int64 | Nil)
• #subtotal : Int64 | Nil
• #subtotal=(subtotal : Int64 | Nil)
• #subtotal_excluding_tax : Int64 | Nil
• #subtotal_excluding_tax=(subtotal_excluding_tax : Int64 | Nil)
• #tax : Int64 | Nil
• #tax=(tax : Int64 | Nil)
• #test_clock : Stripe::InvoiceTestClock | Nil
• #test_clock=(test_clock : Stripe::InvoiceTestClock | Nil)
• #threshold_reason : Stripe::InvoiceThresholdReason | Nil
• #threshold_reason=(threshold_reason : Stripe::InvoiceThresholdReason | Nil)
• #total : Int64 | Nil
• #total=(total : Int64 | Nil)
• #total_discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil
• #total_discount_amounts=(total_discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil)
• #total_excluding_tax : Int64 | Nil
• #total_excluding_tax=(total_excluding_tax : Int64 | Nil)
• #total_tax_amounts : Array(Stripe::InvoiceTaxAmount) | Nil
• #total_tax_amounts=(total_tax_amounts : Array(Stripe::InvoiceTaxAmount) | Nil)
• #transfer_data : Stripe::InvoiceTransferData | Nil
• #transfer_data=(transfer_data : Stripe::InvoiceTransferData | Nil)
• #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=(webhooks_delivered_at : Int64 | Nil)

Constructor Detail

Class Method Detail

Instance Method Detail