Class: Stripe::Invoice

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List, APIOperations::NestedResource, APIOperations::Search
Includes:
APIOperations::Delete, APIOperations::Save
Defined in:
lib/stripe/resources/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, 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 = 
"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

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::NestedResource

nested_resource_class_methods

Methods included from APIOperations::Search

_search

Methods included from APIOperations::Save

included, #save

Methods included from APIOperations::Delete

included

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.



1063
1064
1065
 
# File 'lib/stripe/resources/invoice.rb', line 1063

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.



1065
1066
1067
 
# File 'lib/stripe/resources/invoice.rb', line 1065

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.



1067
1068
1069
 
# File 'lib/stripe/resources/invoice.rb', line 1067

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



1069
1070
1071
 
# File 'lib/stripe/resources/invoice.rb', line 1069

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.



1071
1072
1073
 
# File 'lib/stripe/resources/invoice.rb', line 1071

def amount_overpaid
  @amount_overpaid
end

#amount_paid ⇒ Object (readonly)

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



1073
1074
1075
 
# File 'lib/stripe/resources/invoice.rb', line 1073

def amount_paid
  @amount_paid
end

#amount_remaining ⇒ Object (readonly)

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



1075
1076
1077
 
# File 'lib/stripe/resources/invoice.rb', line 1075

def amount_remaining
  @amount_remaining
end

#amount_shipping ⇒ Object (readonly)

This is the sum of all the shipping amounts.



1077
1078
1079
 
# File 'lib/stripe/resources/invoice.rb', line 1077

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.



1079
1080
1081
 
# File 'lib/stripe/resources/invoice.rb', line 1079

def amounts_due
  @amounts_due
end

#application ⇒ Object (readonly)

ID of the Connect Application that created the invoice.



1081
1082
1083
 
# File 'lib/stripe/resources/invoice.rb', line 1081

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



1083
1084
1085
 
# File 'lib/stripe/resources/invoice.rb', line 1083

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.



1085
1086
1087
 
# File 'lib/stripe/resources/invoice.rb', line 1085

def attempted
  @attempted
end

#auto_advance ⇒ Object (readonly)

Controls whether Stripe performs [automatic collection](docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If ‘false`, the invoice’s state doesn’t automatically advance without an explicit action.



1087
1088
1089
 
# File 'lib/stripe/resources/invoice.rb', line 1087

def auto_advance
  @auto_advance
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



1089
1090
1091
 
# File 'lib/stripe/resources/invoice.rb', line 1089

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.



1091
1092
1093
 
# File 'lib/stripe/resources/invoice.rb', line 1091

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.



1101
1102
1103
 
# File 'lib/stripe/resources/invoice.rb', line 1101

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.



1103
1104
1105
 
# File 'lib/stripe/resources/invoice.rb', line 1103

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.



1105
1106
1107
 
# File 'lib/stripe/resources/invoice.rb', line 1105

def confirmation_secret
  @confirmation_secret
end

#created ⇒ Object (readonly)

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



1107
1108
1109
 
# File 'lib/stripe/resources/invoice.rb', line 1107

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



1109
1110
1111
 
# File 'lib/stripe/resources/invoice.rb', line 1109

def currency
  @currency
end

#custom_fields ⇒ Object (readonly)

Custom fields displayed on the invoice.



1111
1112
1113
 
# File 'lib/stripe/resources/invoice.rb', line 1111

def custom_fields
  @custom_fields
end

#customer ⇒ Object (readonly)

The ID of the customer to bill.



1113
1114
1115
 
# File 'lib/stripe/resources/invoice.rb', line 1113

def customer
  @customer
end

#customer_account ⇒ Object (readonly)

The ID of the account representing the customer to bill.



1115
1116
1117
 
# File 'lib/stripe/resources/invoice.rb', line 1115

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.



1117
1118
1119
 
# File 'lib/stripe/resources/invoice.rb', line 1117

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.



1119
1120
1121
 
# File 'lib/stripe/resources/invoice.rb', line 1119

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.



1121
1122
1123
 
# File 'lib/stripe/resources/invoice.rb', line 1121

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.



1123
1124
1125
 
# File 'lib/stripe/resources/invoice.rb', line 1123

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.



1125
1126
1127
 
# File 'lib/stripe/resources/invoice.rb', line 1125

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.



1127
1128
1129
 
# File 'lib/stripe/resources/invoice.rb', line 1127

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.



1129
1130
1131
 
# File 'lib/stripe/resources/invoice.rb', line 1129

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.



1131
1132
1133
 
# File 'lib/stripe/resources/invoice.rb', line 1131

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.



1133
1134
1135
 
# File 'lib/stripe/resources/invoice.rb', line 1133

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.



1135
1136
1137
 
# File 'lib/stripe/resources/invoice.rb', line 1135

def default_source
  @default_source
end

#default_tax_rates ⇒ Object (readonly)

The tax rates applied to this invoice, if any.



1137
1138
1139
 
# File 'lib/stripe/resources/invoice.rb', line 1137

def default_tax_rates
  @default_tax_rates
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



1139
1140
1141
 
# File 'lib/stripe/resources/invoice.rb', line 1139

def deleted
  @deleted
end

#description ⇒ Object (readonly)

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



1141
1142
1143
 
# File 'lib/stripe/resources/invoice.rb', line 1141

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.



1143
1144
1145
 
# File 'lib/stripe/resources/invoice.rb', line 1143

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



1145
1146
1147
 
# File 'lib/stripe/resources/invoice.rb', line 1145

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.



1147
1148
1149
 
# File 'lib/stripe/resources/invoice.rb', line 1147

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.



1149
1150
1151
 
# File 'lib/stripe/resources/invoice.rb', line 1149

def ending_balance
  @ending_balance
end

#footer ⇒ Object (readonly)

Footer displayed on the invoice.



1151
1152
1153
 
# File 'lib/stripe/resources/invoice.rb', line 1151

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.



1153
1154
1155
 
# File 'lib/stripe/resources/invoice.rb', line 1153

def from_invoice
  @from_invoice
end

#hosted_invoice_url ⇒ Object (readonly)

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.



1155
1156
1157
 
# File 'lib/stripe/resources/invoice.rb', line 1155

def hosted_invoice_url
  @hosted_invoice_url
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`.



1157
1158
1159
 
# File 'lib/stripe/resources/invoice.rb', line 1157

def id
  @id
end

#invoice_pdf ⇒ Object (readonly)

The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.



1159
1160
1161
 
# File 'lib/stripe/resources/invoice.rb', line 1159

def invoice_pdf
  @invoice_pdf
end

#issuer ⇒ Object (readonly)

Attribute for field issuer



1161
1162
1163
 
# File 'lib/stripe/resources/invoice.rb', line 1161

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.



1163
1164
1165
 
# File 'lib/stripe/resources/invoice.rb', line 1163

def last_finalization_error
  @last_finalization_error
end

#latest_revision ⇒ Object (readonly)

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



1165
1166
1167
 
# File 'lib/stripe/resources/invoice.rb', line 1165

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.



1167
1168
1169
 
# File 'lib/stripe/resources/invoice.rb', line 1167

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



1169
1170
1171
 
# File 'lib/stripe/resources/invoice.rb', line 1169

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.



1171
1172
1173
 
# File 'lib/stripe/resources/invoice.rb', line 1171

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



1173
1174
1175
 
# File 'lib/stripe/resources/invoice.rb', line 1173

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.



1175
1176
1177
 
# File 'lib/stripe/resources/invoice.rb', line 1175

def number
  @number
end

#object ⇒ Object (readonly)

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



1177
1178
1179
 
# File 'lib/stripe/resources/invoice.rb', line 1177

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.



1179
1180
1181
 
# File 'lib/stripe/resources/invoice.rb', line 1179

def on_behalf_of
  @on_behalf_of
end

#parent ⇒ Object (readonly)

The parent that generated this invoice



1181
1182
1183
 
# File 'lib/stripe/resources/invoice.rb', line 1181

def parent
  @parent
end

#payment_settings ⇒ Object (readonly)

Attribute for field payment_settings



1183
1184
1185
 
# File 'lib/stripe/resources/invoice.rb', line 1183

def payment_settings
  @payment_settings
end

#payments ⇒ Object (readonly)

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



1185
1186
1187
 
# File 'lib/stripe/resources/invoice.rb', line 1185

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.



1187
1188
1189
 
# File 'lib/stripe/resources/invoice.rb', line 1187

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.



1189
1190
1191
 
# File 'lib/stripe/resources/invoice.rb', line 1189

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.



1191
1192
1193
 
# File 'lib/stripe/resources/invoice.rb', line 1191

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.



1193
1194
1195
 
# File 'lib/stripe/resources/invoice.rb', line 1193

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.



1195
1196
1197
 
# File 'lib/stripe/resources/invoice.rb', line 1195

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.



1197
1198
1199
 
# File 'lib/stripe/resources/invoice.rb', line 1197

def rendering
  @rendering
end

#shipping_cost ⇒ Object (readonly)

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



1199
1200
1201
 
# File 'lib/stripe/resources/invoice.rb', line 1199

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.



1201
1202
1203
 
# File 'lib/stripe/resources/invoice.rb', line 1201

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.



1203
1204
1205
 
# File 'lib/stripe/resources/invoice.rb', line 1203

def starting_balance
  @starting_balance
end

#statement_descriptor ⇒ Object (readonly)

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



1205
1206
1207
 
# File 'lib/stripe/resources/invoice.rb', line 1205

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)



1207
1208
1209
 
# File 'lib/stripe/resources/invoice.rb', line 1207

def status
  @status
end

#status_transitions ⇒ Object (readonly)

Attribute for field status_transitions



1209
1210
1211
 
# File 'lib/stripe/resources/invoice.rb', line 1209

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



1211
1212
1213
 
# File 'lib/stripe/resources/invoice.rb', line 1211

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



1213
1214
1215
 
# File 'lib/stripe/resources/invoice.rb', line 1213

def subtotal_excluding_tax
  @subtotal_excluding_tax
end

#test_clock ⇒ Object (readonly)

ID of the test clock this invoice belongs to.



1215
1216
1217
 
# File 'lib/stripe/resources/invoice.rb', line 1215

def test_clock
  @test_clock
end

#threshold_reason ⇒ Object (readonly)

Attribute for field threshold_reason



1217
1218
1219
 
# File 'lib/stripe/resources/invoice.rb', line 1217

def threshold_reason
  @threshold_reason
end

#total ⇒ Object (readonly)

Total after discounts and taxes.



1219
1220
1221
 
# File 'lib/stripe/resources/invoice.rb', line 1219

def total
  @total
end

#total_discount_amounts ⇒ Object (readonly)

The aggregate amounts calculated per discount across all line items.



1221
1222
1223
 
# File 'lib/stripe/resources/invoice.rb', line 1221

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.



1223
1224
1225
 
# File 'lib/stripe/resources/invoice.rb', line 1223

def total_excluding_tax
  @total_excluding_tax
end

#total_margin_amounts ⇒ Object (readonly)

The aggregate amounts calculated per margin across all line items.



1225
1226
1227
 
# File 'lib/stripe/resources/invoice.rb', line 1225

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.



1227
1228
1229
 
# File 'lib/stripe/resources/invoice.rb', line 1227

def total_pretax_credit_amounts
  @total_pretax_credit_amounts
end

#total_taxes ⇒ Object (readonly)

The aggregate tax information of all line items.



1229
1230
1231
 
# File 'lib/stripe/resources/invoice.rb', line 1229

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.



1231
1232
1233
 
# File 'lib/stripe/resources/invoice.rb', line 1231

def webhooks_delivered_at
  @webhooks_delivered_at
end

Class Method Details

.add_lines(invoice, params = {}, opts = {}) ⇒ Object

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.



1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/stripe/resources/invoice.rb', line 1244

def self.add_lines(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/add_lines", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.attach_payment(invoice, params = {}, opts = {}) ⇒ Object

Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.

For the PaymentIntent, when the PaymentIntent’s status changes to succeeded, the payment is credited to the invoice, increasing its amount_paid. When the invoice is fully paid, the invoice’s status becomes paid.

If the PaymentIntent’s status is already succeeded when it’s attached, it’s credited to the invoice immediately.

See: [Partial payments](docs.stripe.com/docs/invoicing/partial-payments) to learn more.



1282
1283
1284
1285
1286
1287
1288
1289
 
# File 'lib/stripe/resources/invoice.rb', line 1282

def self.attach_payment(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/attach_payment", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.create(params = {}, opts = {}) ⇒ Object

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](/api/invoices/pay) or <a href=“/api/invoices/send”>send](docs.stripe.com/api/invoices/finalize) the invoice to your customers.



1292
1293
1294
 
# File 'lib/stripe/resources/invoice.rb', line 1292

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/invoices", params: params, opts: opts)
end

.create_preview(params = {}, opts = {}) ⇒ Object

At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update.

The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true.

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](docs.stripe.com/currencies/conversions)



1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/stripe/resources/invoice.rb', line 1305

def self.create_preview(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/invoices/create_preview",
    params: params,
    opts: opts
  )
end

.delete(invoice, params = {}, opts = {}) ⇒ Object

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](docs.stripe.com/api/invoices/void).



1315
1316
1317
1318
1319
1320
1321
1322
 
# File 'lib/stripe/resources/invoice.rb', line 1315

def self.delete(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/invoices/%<invoice>s", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.detach_payment(invoice, params = {}, opts = {}) ⇒ Object

Detaches a payment from the invoice, removing it from the list of payments



1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/stripe/resources/invoice.rb', line 1345

def self.detach_payment(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/detach_payment", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.field_remappings ⇒ Object 



1556
1557
1558
 
# File 'lib/stripe/resources/invoice.rb', line 1556

def self.field_remappings
  @field_remappings = {}
end

.finalize_invoice(invoice, params = {}, opts = {}) ⇒ Object

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.



1365
1366
1367
1368
1369
1370
1371
1372
 
# File 'lib/stripe/resources/invoice.rb', line 1365

def self.finalize_invoice(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/finalize", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.inner_class_types ⇒ Object 



1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
 
# File 'lib/stripe/resources/invoice.rb', line 1530

def self.inner_class_types
  @inner_class_types = {
    amounts_due: AmountsDue,
    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

.list(params = {}, opts = {}) ⇒ Object

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.



1375
1376
1377
 
# File 'lib/stripe/resources/invoice.rb', line 1375

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/invoices", params: params, opts: opts)
end

.mark_uncollectible(invoice, params = {}, opts = {}) ⇒ Object

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.



1390
1391
1392
1393
1394
1395
1396
1397
 
# File 'lib/stripe/resources/invoice.rb', line 1390

def self.mark_uncollectible(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/mark_uncollectible", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



46
47
48
 
# File 'lib/stripe/resources/invoice.rb', line 46

def self.object_name
  "invoice"
end

.pay(invoice, params = {}, opts = {}) ⇒ Object

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your [subscriptions settings](dashboard.stripe.com/account/billing/automatic). However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.



1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/stripe/resources/invoice.rb', line 1410

def self.pay(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/pay", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.remove_lines(invoice, params = {}, opts = {}) ⇒ Object

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.



1430
1431
1432
1433
1434
1435
1436
1437
 
# File 'lib/stripe/resources/invoice.rb', line 1430

def self.remove_lines(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/remove_lines", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.search(params = {}, opts = {}) ⇒ Object 



1439
1440
1441
 
# File 'lib/stripe/resources/invoice.rb', line 1439

def self.search(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/invoices/search", params: params, opts: opts)
end

.search_auto_paging_each(params = {}, opts = {}, &blk) ⇒ Object 



1443
1444
1445
 
# File 'lib/stripe/resources/invoice.rb', line 1443

def self.search_auto_paging_each(params = {}, opts = {}, &blk)
  search(params, opts).auto_paging_each(&blk)
end

.send_invoice(invoice, params = {}, opts = {}) ⇒ Object

Stripe will automatically send invoices to customers according to your [subscriptions settings](dashboard.stripe.com/account/billing/automatic). However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.



1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/stripe/resources/invoice.rb', line 1462

def self.send_invoice(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/send", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.update(invoice, params = {}, opts = {}) ⇒ Object

Draft invoices are fully editable. Once an invoice is [finalized](docs.stripe.com/docs/billing/invoices/workflow#finalized), monetary values, as well as collection_method, become uneditable.

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or [automatically reconciling](docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass auto_advance=false.



1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/stripe/resources/invoice.rb', line 1477

def self.update(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.update_lines(invoice, params = {}, opts = {}) ⇒ Object

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.



1497
1498
1499
1500
1501
1502
1503
1504
 
# File 'lib/stripe/resources/invoice.rb', line 1497

def self.update_lines(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/update_lines", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

.void_invoice(invoice, params = {}, opts = {}) ⇒ Object

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](docs.stripe.com/api/invoices/delete), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to [issue another invoice or <a href=“/api/credit_notes/create”>credit note](docs.stripe.com/api/invoices/create) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.



1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/stripe/resources/invoice.rb', line 1521

def self.void_invoice(invoice, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/void", { invoice: CGI.escape(invoice) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#add_lines(params = {}, opts = {}) ⇒ Object

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.



1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/stripe/resources/invoice.rb', line 1234

def add_lines(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/add_lines", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#attach_payment(params = {}, opts = {}) ⇒ Object

Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.

For the PaymentIntent, when the PaymentIntent’s status changes to succeeded, the payment is credited to the invoice, increasing its amount_paid. When the invoice is fully paid, the invoice’s status becomes paid.

If the PaymentIntent’s status is already succeeded when it’s attached, it’s credited to the invoice immediately.

See: [Partial payments](docs.stripe.com/docs/invoicing/partial-payments) to learn more.



1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/stripe/resources/invoice.rb', line 1263

def attach_payment(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/attach_payment", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#delete(params = {}, opts = {}) ⇒ Object

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](docs.stripe.com/api/invoices/void).



1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'lib/stripe/resources/invoice.rb', line 1325

def delete(params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/invoices/%<invoice>s", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#detach_payment(params = {}, opts = {}) ⇒ Object

Detaches a payment from the invoice, removing it from the list of payments



1335
1336
1337
1338
1339
1340
1341
1342
 
# File 'lib/stripe/resources/invoice.rb', line 1335

def detach_payment(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/detach_payment", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#finalize_invoice(params = {}, opts = {}) ⇒ Object

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.



1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'lib/stripe/resources/invoice.rb', line 1355

def finalize_invoice(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/finalize", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#mark_uncollectible(params = {}, opts = {}) ⇒ Object

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.



1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'lib/stripe/resources/invoice.rb', line 1380

def mark_uncollectible(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/mark_uncollectible", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#pay(params = {}, opts = {}) ⇒ Object

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your [subscriptions settings](dashboard.stripe.com/account/billing/automatic). However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.



1400
1401
1402
1403
1404
1405
1406
1407
 
# File 'lib/stripe/resources/invoice.rb', line 1400

def pay(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/pay", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#remove_lines(params = {}, opts = {}) ⇒ Object

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.



1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'lib/stripe/resources/invoice.rb', line 1420

def remove_lines(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/remove_lines", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#send_invoice(params = {}, opts = {}) ⇒ Object

Stripe will automatically send invoices to customers according to your [subscriptions settings](dashboard.stripe.com/account/billing/automatic). However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.



1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'lib/stripe/resources/invoice.rb', line 1450

def send_invoice(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/send", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#update_lines(params = {}, opts = {}) ⇒ Object

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.



1487
1488
1489
1490
1491
1492
1493
1494
 
# File 'lib/stripe/resources/invoice.rb', line 1487

def update_lines(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/update_lines", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#void_invoice(params = {}, opts = {}) ⇒ Object

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](docs.stripe.com/api/invoices/delete), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to [issue another invoice or <a href=“/api/credit_notes/create”>credit note](docs.stripe.com/api/invoices/create) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.



1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/stripe/resources/invoice.rb', line 1509

def void_invoice(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoices/%<invoice>s/void", { invoice: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end