Class: Stripe::QuotePreviewInvoice

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/quote_preview_invoice.rb

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](stripe.com/docs/api#invoiceitems), 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](stripe.com/docs/invoicing/integration/automatic-advancement-collection), 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](dashboard.stripe.com/account/billing/automatic), 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](stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), 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](stripe.com/docs/billing/customer/balance).

Related guide: [Send invoices to customers](stripe.com/docs/billing/invoices/sending)

Defined Under Namespace

Classes: AmountsDue, AppliesTo, AutomaticTax, CustomField, CustomerAddress, CustomerShipping, CustomerTaxId, FromInvoice, Issuer, LastFinalizationError, PaymentSettings, Rendering, ShippingCost, ShippingDetails, StatusTransitions, SubscriptionDetails, ThresholdReason, TotalDiscountAmount, TotalMarginAmount, TotalPretaxCreditAmount, TotalTaxAmount, TransferData

Constant Summary collapse

OBJECT_NAME = 
"quote_preview_invoice"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#account_country ⇒ Object (readonly)

The country of the business associated with this invoice, most often the business creating the invoice.



571
572
573
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 571

def 
  @account_country
end

#account_name ⇒ Object (readonly)

The public name of the business associated with this invoice, most often the business creating the invoice.



574
575
576
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 574

def 
  @account_name
end

#account_tax_ids ⇒ Object (readonly)

The account tax IDs associated with the invoice. Only editable when the invoice is a draft.



577
578
579
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 577

def 
  @account_tax_ids
end

#amount_due ⇒ Object (readonly)

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`.



580
581
582
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 580

def amount_due
  @amount_due
end

#amount_overpaid ⇒ Object (readonly)

Amount that was overpaid on the invoice. Overpayments are debited to the customer’s credit balance.



583
584
585
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 583

def amount_overpaid
  @amount_overpaid
end

#amount_paid ⇒ Object (readonly)

The amount, in cents (or local equivalent), that was paid.



586
587
588
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 586

def amount_paid
  @amount_paid
end

#amount_remaining ⇒ Object (readonly)

The difference between amount_due and amount_paid, in cents (or local equivalent).



589
590
591
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 589

def amount_remaining
  @amount_remaining
end

#amount_shipping ⇒ Object (readonly)

This is the sum of all the shipping amounts.



592
593
594
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 592

def amount_shipping
  @amount_shipping
end

#amounts_due ⇒ Object (readonly)

List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.



595
596
597
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 595

def amounts_due
  @amounts_due
end

#application ⇒ Object (readonly)

ID of the Connect Application that created the invoice.



598
599
600
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 598

def application
  @application
end

#application_fee_amount ⇒ Object (readonly)

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.



601
602
603
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 601

def application_fee_amount
  @application_fee_amount
end

#applies_to ⇒ Object (readonly)

Attribute for field applies_to



604
605
606
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 604

def applies_to
  @applies_to
end

#attempt_count ⇒ Object (readonly)

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.



607
608
609
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 607

def attempt_count
  @attempt_count
end

#attempted ⇒ Object (readonly)

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.



610
611
612
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 610

def attempted
  @attempted
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



613
614
615
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 613

def automatic_tax
  @automatic_tax
end

#automatically_finalizes_at ⇒ Object (readonly)

The time when this invoice is currently scheduled to be automatically finalized. The field will be ‘null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.



616
617
618
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 616

def automatically_finalizes_at
  @automatically_finalizes_at
end

#billing_reason ⇒ Object (readonly)

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.



627
628
629
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 627

def billing_reason
  @billing_reason
end

#collection_method ⇒ Object (readonly)

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.



630
631
632
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 630

def collection_method
  @collection_method
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



633
634
635
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 633

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



636
637
638
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 636

def currency
  @currency
end

#custom_fields ⇒ Object (readonly)

Custom fields displayed on the invoice.



639
640
641
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 639

def custom_fields
  @custom_fields
end

#customer_address ⇒ Object (readonly)

The customer’s address. Until the invoice is finalized, this field will equal ‘customer.address`. Once the invoice is finalized, this field will no longer be updated.



642
643
644
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 642

def customer_address
  @customer_address
end

#customer_email ⇒ Object (readonly)

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.



645
646
647
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 645

def customer_email
  @customer_email
end

#customer_name ⇒ Object (readonly)

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.



648
649
650
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 648

def customer_name
  @customer_name
end

#customer_phone ⇒ Object (readonly)

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.



651
652
653
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 651

def customer_phone
  @customer_phone
end

#customer_shipping ⇒ Object (readonly)

The customer’s shipping information. Until the invoice is finalized, this field will equal ‘customer.shipping`. Once the invoice is finalized, this field will no longer be updated.



654
655
656
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 654

def customer_shipping
  @customer_shipping
end

#customer_tax_exempt ⇒ Object (readonly)

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.



657
658
659
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 657

def customer_tax_exempt
  @customer_tax_exempt
end

#customer_tax_ids ⇒ Object (readonly)

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.



660
661
662
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 660

def customer_tax_ids
  @customer_tax_ids
end

#default_margins ⇒ Object (readonly)

The margins applied to the invoice. Can be overridden by line item ‘margins`. Use `expand[]=default_margins` to expand each margin.



663
664
665
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 663

def default_margins
  @default_margins
end

#default_payment_method ⇒ Object (readonly)

ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription’s default payment method, if any, or to the default payment method in the customer’s invoice settings.



666
667
668
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 666

def default_payment_method
  @default_payment_method
end

#default_source ⇒ Object (readonly)

ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription’s default source, if any, or to the customer’s default source.



669
670
671
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 669

def default_source
  @default_source
end

#default_tax_rates ⇒ Object (readonly)

The tax rates applied to this invoice, if any.



672
673
674
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 672

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object (readonly)

An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.



675
676
677
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 675

def description
  @description
end

#discount ⇒ Object (readonly)

Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.



678
679
680
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 678

def discount
  @discount
end

#discounts ⇒ Object (readonly)

The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use ‘expand[]=discounts` to expand each discount.



681
682
683
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 681

def discounts
  @discounts
end

#due_date ⇒ Object (readonly)

The date on which payment for this invoice is due. This value will be ‘null` for invoices where `collection_method=charge_automatically`.



684
685
686
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 684

def due_date
  @due_date
end

#effective_at ⇒ Object (readonly)

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.



687
688
689
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 687

def effective_at
  @effective_at
end

#ending_balance ⇒ Object (readonly)

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.



690
691
692
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 690

def ending_balance
  @ending_balance
end

#footer ⇒ Object (readonly)

Footer displayed on the invoice.



693
694
695
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 693

def footer
  @footer
end

#from_invoice ⇒ Object (readonly)

Details of the invoice that was cloned. See the [revision documentation](stripe.com/docs/invoicing/invoice-revisions) for more details.



696
697
698
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 696

def from_invoice
  @from_invoice
end

#id ⇒ Object (readonly)

Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](stripe.com/docs/api/invoices/upcoming) for more details.



699
700
701
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 699

def id
  @id
end

#issuer ⇒ Object (readonly)

Attribute for field issuer



702
703
704
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 702

def issuer
  @issuer
end

#last_finalization_error ⇒ Object (readonly)

The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.



705
706
707
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 705

def last_finalization_error
  @last_finalization_error
end

#latest_revision ⇒ Object (readonly)

The ID of the most recent non-draft revision of this invoice



708
709
710
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 708

def latest_revision
  @latest_revision
end

#lines ⇒ Object (readonly)

The individual line items that make up the invoice. ‘lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.



711
712
713
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 711

def lines
  @lines
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



714
715
716
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 714

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](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.



717
718
719
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 717

def metadata
  @metadata
end

#next_payment_attempt ⇒ Object (readonly)

The time at which payment will next be attempted. This value will be ‘null` for invoices where `collection_method=send_invoice`.



720
721
722
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 720

def next_payment_attempt
  @next_payment_attempt
end

#number ⇒ Object (readonly)

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.



723
724
725
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 723

def number
  @number
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



726
727
728
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 726

def object
  @object
end

#on_behalf_of ⇒ Object (readonly)

The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](stripe.com/docs/billing/invoices/connect) documentation for details.



729
730
731
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 729

def on_behalf_of
  @on_behalf_of
end

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.



732
733
734
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 732

def paid
  @paid
end

Returns true if the invoice was manually marked paid, returns false if the invoice hasn’t been paid yet or was paid on Stripe.



735
736
737
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 735

def paid_out_of_band
  @paid_out_of_band
end

#payment_intent ⇒ Object (readonly)

The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.



738
739
740
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 738

def payment_intent
  @payment_intent
end

#payment_settings ⇒ Object (readonly)

Attribute for field payment_settings



741
742
743
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 741

def payment_settings
  @payment_settings
end

#payments ⇒ Object (readonly)

Payments for this invoice



744
745
746
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 744

def payments
  @payments
end

#period_end ⇒ Object (readonly)

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](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.



747
748
749
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 747

def period_end
  @period_end
end

#period_start ⇒ Object (readonly)

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](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.



750
751
752
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 750

def period_start
  @period_start
end

#post_payment_credit_notes_amount ⇒ Object (readonly)

Total amount of all post-payment credit notes issued for this invoice.



753
754
755
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 753

def post_payment_credit_notes_amount
  @post_payment_credit_notes_amount
end

#pre_payment_credit_notes_amount ⇒ Object (readonly)

Total amount of all pre-payment credit notes issued for this invoice.



756
757
758
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 756

def pre_payment_credit_notes_amount
  @pre_payment_credit_notes_amount
end

#quote ⇒ Object (readonly)

The quote this invoice was generated from.



759
760
761
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 759

def quote
  @quote
end

#receipt_number ⇒ Object (readonly)

This is the transaction number that appears on email receipts sent for this invoice.



762
763
764
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 762

def receipt_number
  @receipt_number
end

#rendering ⇒ Object (readonly)

The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.



765
766
767
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 765

def rendering
  @rendering
end

#shipping_cost ⇒ Object (readonly)

The details of the cost of shipping, including the ShippingRate applied on the invoice.



768
769
770
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 768

def shipping_cost
  @shipping_cost
end

#shipping_details ⇒ Object (readonly)

Shipping details for the invoice. The Invoice PDF will use the ‘shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.



771
772
773
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 771

def shipping_details
  @shipping_details
end

#starting_balance ⇒ Object (readonly)

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.



774
775
776
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 774

def starting_balance
  @starting_balance
end

#statement_descriptor ⇒ Object (readonly)

Extra information about an invoice for the customer’s credit card statement.



777
778
779
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 777

def statement_descriptor
  @statement_descriptor
end

#status ⇒ Object (readonly)

The status of the invoice, one of ‘draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](stripe.com/docs/billing/invoices/workflow#workflow-overview)



780
781
782
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 780

def status
  @status
end

#status_transitions ⇒ Object (readonly)

Attribute for field status_transitions



783
784
785
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 783

def status_transitions
  @status_transitions
end

#subscription ⇒ Object (readonly)

Attribute for field subscription



786
787
788
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 786

def subscription
  @subscription
end

#subscription_details ⇒ Object (readonly)

Details about the subscription that created this invoice.



789
790
791
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 789

def subscription_details
  @subscription_details
end

#subscription_proration_date ⇒ Object (readonly)

Only set for upcoming invoices that preview prorations. The time used to calculate prorations.



792
793
794
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 792

def subscription_proration_date
  @subscription_proration_date
end

#subtotal ⇒ Object (readonly)

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



795
796
797
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 795

def subtotal
  @subtotal
end

#subtotal_excluding_tax ⇒ Object (readonly)

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



798
799
800
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 798

def subtotal_excluding_tax
  @subtotal_excluding_tax
end

#tax ⇒ Object (readonly)

The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.



801
802
803
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 801

def tax
  @tax
end

#test_clock ⇒ Object (readonly)

ID of the test clock this invoice belongs to.



804
805
806
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 804

def test_clock
  @test_clock
end

#threshold_reason ⇒ Object (readonly)

Attribute for field threshold_reason



807
808
809
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 807

def threshold_reason
  @threshold_reason
end

#total ⇒ Object (readonly)

Total after discounts and taxes.



810
811
812
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 810

def total
  @total
end

#total_discount_amounts ⇒ Object (readonly)

The aggregate amounts calculated per discount across all line items.



813
814
815
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 813

def total_discount_amounts
  @total_discount_amounts
end

#total_excluding_tax ⇒ Object (readonly)

The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.



816
817
818
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 816

def total_excluding_tax
  @total_excluding_tax
end

#total_margin_amounts ⇒ Object (readonly)

The aggregate amounts calculated per margin across all line items.



819
820
821
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 819

def total_margin_amounts
  @total_margin_amounts
end

#total_pretax_credit_amounts ⇒ Object (readonly)

Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.



822
823
824
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 822

def total_pretax_credit_amounts
  @total_pretax_credit_amounts
end

#total_tax_amounts ⇒ Object (readonly)

The aggregate amounts calculated per tax rate for all line items.



825
826
827
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 825

def total_tax_amounts
  @total_tax_amounts
end

#transfer_data ⇒ Object (readonly)

The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.



828
829
830
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 828

def transfer_data
  @transfer_data
end

#webhooks_delivered_at ⇒ Object (readonly)

Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](stripe.com/docs/billing/webhooks#understand). 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.



831
832
833
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 831

def webhooks_delivered_at
  @webhooks_delivered_at
end

Class Method Details

.object_name ⇒ Object 



39
40
41
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 39

def self.object_name
  "quote_preview_invoice"
end