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](api.stripe.com#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](docs.stripe.com/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](docs.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](docs.stripe.com/billing/customer/balance).

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

Defined Under Namespace

Classes: AmountsDue, AppliesTo, AutomaticTax, ConfirmationSecret, CustomField, CustomerAddress, CustomerShipping, CustomerTaxId, FromInvoice, Issuer, LastFinalizationError, Parent, PaymentSettings, Rendering, ShippingCost, ShippingDetails, StatusTransitions, ThresholdReason, TotalDiscountAmount, TotalMarginAmount, TotalPretaxCreditAmount, TotalTax

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

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #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.



1046
1047
1048
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1046

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.



1048
1049
1050
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1048

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.



1050
1051
1052
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1050

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



1052
1053
1054
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1052

def amount_due
  @amount_due
end

#amount_overpaid ⇒ Object (readonly)

Amount that was overpaid on the invoice. The amount overpaid is credited to the customer’s credit balance.



1054
1055
1056
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1054

def amount_overpaid
  @amount_overpaid
end

#amount_paid ⇒ Object (readonly)

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



1056
1057
1058
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1056

def amount_paid
  @amount_paid
end

#amount_remaining ⇒ Object (readonly)

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



1058
1059
1060
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1058

def amount_remaining
  @amount_remaining
end

#amount_shipping ⇒ Object (readonly)

This is the sum of all the shipping amounts.



1060
1061
1062
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1060

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.



1062
1063
1064
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1062

def amounts_due
  @amounts_due
end

#application ⇒ Object (readonly)

ID of the Connect Application that created the invoice.



1064
1065
1066
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1064

def application
  @application
end

#applies_to ⇒ Object (readonly)

Attribute for field applies_to



1066
1067
1068
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1066

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.



1068
1069
1070
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1068

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.



1070
1071
1072
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1070

def attempted
  @attempted
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



1072
1073
1074
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1072

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.



1074
1075
1076
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1074

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 upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription.



1084
1085
1086
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1084

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.



1086
1087
1088
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1086

def collection_method
  @collection_method
end

#confirmation_secret ⇒ Object (readonly)

The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.



1088
1089
1090
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1088

def confirmation_secret
  @confirmation_secret
end

#created ⇒ Object (readonly)

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



1090
1091
1092
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1090

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



1092
1093
1094
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1092

def currency
  @currency
end

#custom_fields ⇒ Object (readonly)

Custom fields displayed on the invoice.



1094
1095
1096
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1094

def custom_fields
  @custom_fields
end

#customer_account ⇒ Object (readonly)

The ID of the account representing the customer to bill.



1096
1097
1098
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1096

def 
  @customer_account
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.



1098
1099
1100
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1098

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.



1100
1101
1102
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1100

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.



1102
1103
1104
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1102

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.



1104
1105
1106
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1104

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.



1106
1107
1108
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1106

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.



1108
1109
1110
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1108

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.



1110
1111
1112
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1110

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.



1112
1113
1114
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1112

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.



1114
1115
1116
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1114

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.



1116
1117
1118
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1116

def default_source
  @default_source
end

#default_tax_rates ⇒ Object (readonly)

The tax rates applied to this invoice, if any.



1118
1119
1120
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1118

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.



1120
1121
1122
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1120

def description
  @description
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.



1122
1123
1124
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1122

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



1124
1125
1126
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1124

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.



1126
1127
1128
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1126

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.



1128
1129
1130
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1128

def ending_balance
  @ending_balance
end

#footer ⇒ Object (readonly)

Footer displayed on the invoice.



1130
1131
1132
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1130

def footer
  @footer
end

#from_invoice ⇒ Object (readonly)

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



1132
1133
1134
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1132

def from_invoice
  @from_invoice
end

#id ⇒ Object (readonly)

Unique identifier for the object. For preview invoices created using the [create preview](stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with ‘upcoming_in`.



1134
1135
1136
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1134

def id
  @id
end

#issuer ⇒ Object (readonly)

Attribute for field issuer



1136
1137
1138
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1136

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.



1138
1139
1140
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1138

def last_finalization_error
  @last_finalization_error
end

#latest_revision ⇒ Object (readonly)

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



1140
1141
1142
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1140

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.



1142
1143
1144
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1142

def lines
  @lines
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is ‘true`. If the object exists in test mode, the value is `false`.



1144
1145
1146
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1144

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



1146
1147
1148
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1146

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



1148
1149
1150
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1148

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.



1150
1151
1152
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1150

def number
  @number
end

#object ⇒ Object (readonly)

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



1152
1153
1154
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1152

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](docs.stripe.com/billing/invoices/connect) documentation for details.



1154
1155
1156
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1154

def on_behalf_of
  @on_behalf_of
end

#parent ⇒ Object (readonly)

The parent that generated this invoice



1156
1157
1158
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1156

def parent
  @parent
end

#payment_settings ⇒ Object (readonly)

Attribute for field payment_settings



1158
1159
1160
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1158

def payment_settings
  @payment_settings
end

#payments ⇒ Object (readonly)

Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details.



1160
1161
1162
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1160

def payments
  @payments
end

#period_end ⇒ Object (readonly)

The latest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.



1162
1163
1164
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1162

def period_end
  @period_end
end

#period_start ⇒ Object (readonly)

The earliest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.



1164
1165
1166
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1164

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.



1166
1167
1168
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1166

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.



1168
1169
1170
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1168

def pre_payment_credit_notes_amount
  @pre_payment_credit_notes_amount
end

#receipt_number ⇒ Object (readonly)

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



1170
1171
1172
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1170

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.



1172
1173
1174
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1172

def rendering
  @rendering
end

#shipping_cost ⇒ Object (readonly)

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



1174
1175
1176
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1174

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.



1176
1177
1178
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1176

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.



1178
1179
1180
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1178

def starting_balance
  @starting_balance
end

#statement_descriptor ⇒ Object (readonly)

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



1180
1181
1182
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1180

def statement_descriptor
  @statement_descriptor
end

#status ⇒ Object (readonly)

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



1182
1183
1184
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1182

def status
  @status
end

#status_transitions ⇒ Object (readonly)

Attribute for field status_transitions



1184
1185
1186
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1184

def status_transitions
  @status_transitions
end

#subscription ⇒ Object (readonly)

Attribute for field subscription



1186
1187
1188
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1186

def subscription
  @subscription
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



1188
1189
1190
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1188

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



1190
1191
1192
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1190

def subtotal_excluding_tax
  @subtotal_excluding_tax
end

#test_clock ⇒ Object (readonly)

ID of the test clock this invoice belongs to.



1192
1193
1194
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1192

def test_clock
  @test_clock
end

#threshold_reason ⇒ Object (readonly)

Attribute for field threshold_reason



1194
1195
1196
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1194

def threshold_reason
  @threshold_reason
end

#total ⇒ Object (readonly)

Total after discounts and taxes.



1196
1197
1198
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1196

def total
  @total
end

#total_discount_amounts ⇒ Object (readonly)

The aggregate amounts calculated per discount across all line items.



1198
1199
1200
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1198

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.



1200
1201
1202
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1200

def total_excluding_tax
  @total_excluding_tax
end

#total_margin_amounts ⇒ Object (readonly)

The aggregate amounts calculated per margin across all line items.



1202
1203
1204
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1202

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.



1204
1205
1206
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1204

def total_pretax_credit_amounts
  @total_pretax_credit_amounts
end

#total_taxes ⇒ Object (readonly)

The aggregate tax information of all line items.



1206
1207
1208
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1206

def total_taxes
  @total_taxes
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](docs.stripe.com/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.



1208
1209
1210
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1208

def webhooks_delivered_at
  @webhooks_delivered_at
end

Class Method Details

.field_remappings ⇒ Object 



1237
1238
1239
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1237

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
 
# File 'lib/stripe/resources/quote_preview_invoice.rb', line 1210

def self.inner_class_types
  @inner_class_types = {
    amounts_due: AmountsDue,
    applies_to: AppliesTo,
    automatic_tax: AutomaticTax,
    confirmation_secret: ConfirmationSecret,
    custom_fields: CustomField,
    customer_address: CustomerAddress,
    customer_shipping: CustomerShipping,
    customer_tax_ids: CustomerTaxId,
    from_invoice: FromInvoice,
    issuer: Issuer,
    last_finalization_error: LastFinalizationError,
    parent: Parent,
    payment_settings: PaymentSettings,
    rendering: Rendering,
    shipping_cost: ShippingCost,
    shipping_details: ShippingDetails,
    status_transitions: StatusTransitions,
    threshold_reason: ThresholdReason,
    total_discount_amounts: TotalDiscountAmount,
    total_margin_amounts: TotalMarginAmount,
    total_pretax_credit_amounts: TotalPretaxCreditAmount,
    total_taxes: TotalTax,
  }
end

.object_name ⇒ Object 



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

def self.object_name
  "quote_preview_invoice"
end