Stripe::Invoice
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
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
Constants
Constructors
Instance methods
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
The country of the business associated with this invoice, most often the business creating the invoice.
Custom attribute writer method checking allowed values (enum). @param [Object] account_country Object to be assigned
The public name of the business associated with this invoice, most often the business creating the invoice.
Custom attribute writer method checking allowed values (enum). @param [Object] account_name Object to be assigned
The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
Custom attribute writer method checking allowed values (enum). @param [Object] account_tax_ids Object to be assigned
Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
Custom attribute writer method checking allowed values (enum). @param [Object] amount_due Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] amount_paid Object to be assigned
The difference between amount_due and amount_paid, in cents (or local equivalent).
Custom attribute writer method checking allowed values (enum). @param [Object] amount_remaining Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] amount_shipping Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] application Object to be assigned
The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.
Custom attribute writer method checking allowed values (enum). @param [Object] application_fee_amount Object to be assigned
Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
Custom attribute writer method checking allowed values (enum). @param [Object] attempt_count Object to be assigned
Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
Custom attribute writer method checking allowed values (enum). @param [Object] attempted Object to be assigned
Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
Custom attribute writer method checking allowed values (enum). @param [Object] auto_advance Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] automatic_tax Object to be assigned
Indicates the reason why the invoice was created. * manual: Unrelated to a subscription, for example, created via the invoice editor. * subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. * subscription_create: A new subscription was created. * subscription_cycle: A subscription advanced into a new period. * subscription_threshold: A subscription reached a billing threshold. * subscription_update: A subscription was updated. * upcoming: Reserved for simulated invoices, per the upcoming invoice endpoint.
Custom attribute writer method checking allowed values (enum). @param [Object] billing_reason Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] charge Object to be assigned
Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
Custom attribute writer method checking allowed values (enum). @param [Object] collection_method Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] custom_fields Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] customer Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] customer_address Object to be assigned
The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
Custom attribute writer method checking allowed values (enum). @param [Object] customer_email Object to be assigned
The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
Custom attribute writer method checking allowed values (enum). @param [Object] customer_name Object to be assigned
The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
Custom attribute writer method checking allowed values (enum). @param [Object] customer_phone Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] customer_shipping Object to be assigned
The customer's tax exempt status. Until the invoice is finalized, this field will equal customer.tax_exempt. Once the invoice is finalized, this field will no longer be updated.
Custom attribute writer method checking allowed values (enum). @param [Object] customer_tax_exempt Object to be assigned
The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
Custom attribute writer method checking allowed values (enum). @param [Object] customer_tax_ids Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] default_payment_method Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] default_source Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] default_tax_rates Object to be assigned
An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] discount Object to be assigned
The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
Custom attribute writer method checking allowed values (enum). @param [Object] discounts Object to be assigned
The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
Custom attribute writer method checking allowed values (enum). @param [Object] due_date Object to be assigned
The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
Custom attribute writer method checking allowed values (enum). @param [Object] effective_at Object to be assigned
Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
Custom attribute writer method checking allowed values (enum). @param [Object] ending_balance Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] from_invoice Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
Custom attribute writer method checking allowed values (enum). @param [Object] hosted_invoice_url Object to be assigned
Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See Retrieve an upcoming invoice for more details.
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
Custom attribute writer method checking allowed values (enum). @param [Object] invoice_pdf Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] issuer Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] last_finalization_error Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] latest_revision Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] lines Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned
The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
Custom attribute writer method checking allowed values (enum). @param [Object] next_payment_attempt Object to be assigned
A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
Custom attribute writer method checking allowed values (enum). @param [Object] number Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] on_behalf_of Object to be assigned
Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
Custom attribute writer method checking allowed values (enum). @param [Object] paid Object to be assigned
Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.
Custom attribute writer method checking allowed values (enum). @param [Object] paid_out_of_band Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_intent Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_settings Object to be assigned
End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price.
Custom attribute writer method checking allowed values (enum). @param [Object] period_end Object to be assigned
Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price.
Custom attribute writer method checking allowed values (enum). @param [Object] period_start Object to be assigned
Total amount of all post-payment credit notes issued for this invoice.
Custom attribute writer method checking allowed values (enum). @param [Object] post_payment_credit_notes_amount Object to be assigned
Total amount of all pre-payment credit notes issued for this invoice.
Custom attribute writer method checking allowed values (enum). @param [Object] pre_payment_credit_notes_amount Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] quote Object to be assigned
This is the transaction number that appears on email receipts sent for this invoice.
Custom attribute writer method checking allowed values (enum). @param [Object] receipt_number Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] rendering Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] shipping_cost Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] shipping_details Object to be assigned
Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
Custom attribute writer method checking allowed values (enum). @param [Object] starting_balance Object to be assigned
Extra information about an invoice for the customer's credit card statement.
Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor Object to be assigned
The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] status_transitions Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] subscription Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] subscription_details Object to be assigned
Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
Custom attribute writer method checking allowed values (enum). @param [Object] subscription_proration_date Object to be assigned
Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
Custom attribute writer method checking allowed values (enum). @param [Object] subtotal Object to be assigned
The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
Custom attribute writer method checking allowed values (enum). @param [Object] subtotal_excluding_tax Object to be assigned
The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
Custom attribute writer method checking allowed values (enum). @param [Object] tax Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] test_clock Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] threshold_reason Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] total Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] total_discount_amounts Object to be assigned
The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
Custom attribute writer method checking allowed values (enum). @param [Object] total_excluding_tax Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] total_tax_amounts Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] transfer_data Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid
Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.