Package com.stripe.model

Class QuotePreviewInvoice

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.QuotePreviewInvoice
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class QuotePreviewInvoice extends ApiResource implements HasId
Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.

They contain invoice items, and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).

If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, when automatic, does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice.

If your invoice is configured to be billed by sending an email, then based on your email settings, Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice.

Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe's minimum allowed charge per currency, the invoice is automatically marked paid, and we add the amount due to the customer's credit balance which is applied to the next invoice.

More details on the customer's credit balance are here.

Related guide: Send invoices to customers

  • Constructor Details

    • QuotePreviewInvoice

      public QuotePreviewInvoice()

  • Method Details

    • getApplication

      public String getApplication()
      Get ID of expandable application object.

    • setApplication

      public void setApplication(String id)

    • getApplicationObject

      public Application getApplicationObject()
      Get expanded application.

    • setApplicationObject

      public void setApplicationObject(Application expandableObject)

    • getDefaultPaymentMethod

      public String getDefaultPaymentMethod()
      Get ID of expandable defaultPaymentMethod object.

    • setDefaultPaymentMethod

      public void setDefaultPaymentMethod(String id)

    • getDefaultPaymentMethodObject

      public PaymentMethod getDefaultPaymentMethodObject()
      Get expanded defaultPaymentMethod.

    • setDefaultPaymentMethodObject

      public void setDefaultPaymentMethodObject(PaymentMethod expandableObject)

    • getDefaultSource

      public String getDefaultSource()
      Get ID of expandable defaultSource object.

    • setDefaultSource

      public void setDefaultSource(String id)

    • getDefaultSourceObject

      public PaymentSource getDefaultSourceObject()
      Get expanded defaultSource.

    • setDefaultSourceObject

      public void setDefaultSourceObject(PaymentSource expandableObject)

    • getLatestRevision

      public String getLatestRevision()
      Get ID of expandable latestRevision object.

    • setLatestRevision

      public void setLatestRevision(String id)

    • getLatestRevisionObject

      public Invoice getLatestRevisionObject()
      Get expanded latestRevision.

    • setLatestRevisionObject

      public void setLatestRevisionObject(Invoice expandableObject)

    • getOnBehalfOf

      public String getOnBehalfOf()
      Get ID of expandable onBehalfOf object.

    • setOnBehalfOf

      public void setOnBehalfOf(String id)

    • getOnBehalfOfObject

      public Account getOnBehalfOfObject()
      Get expanded onBehalfOf.

    • setOnBehalfOfObject

      public void setOnBehalfOfObject(Account expandableObject)

    • getSubscription

      public String getSubscription()
      Get ID of expandable subscription object.

    • setSubscription

      public void setSubscription(String id)

    • getSubscriptionObject

      public Subscription getSubscriptionObject()
      Get expanded subscription.

    • setSubscriptionObject

      public void setSubscriptionObject(Subscription expandableObject)

    • getTestClock

      public String getTestClock()
      Get ID of expandable testClock object.

    • setTestClock

      public void setTestClock(String id)

    • getTestClockObject

      public TestClock getTestClockObject()
      Get expanded testClock.

    • setTestClockObject

      public void setTestClockObject(TestClock expandableObject)

    • getAccountTaxIds

      public List<String> getAccountTaxIds()
      Get IDs of expandable accountTaxIds object list.

    • setAccountTaxIds

      public void setAccountTaxIds(List<String> ids)

    • getAccountTaxIdObjects

      public List<TaxId> getAccountTaxIdObjects()
      Get expanded accountTaxIds.

    • setAccountTaxIdObjects

      public void setAccountTaxIdObjects(List<TaxId> objs)

    • getDefaultMargins

      public List<String> getDefaultMargins()
      Get IDs of expandable defaultMargins object list.

    • setDefaultMargins

      public void setDefaultMargins(List<String> ids)

    • getDefaultMarginObjects

      public List<Margin> getDefaultMarginObjects()
      Get expanded defaultMargins.

    • setDefaultMarginObjects

      public void setDefaultMarginObjects(List<Margin> objs)

    • getDiscounts

      public List<String> getDiscounts()
      Get IDs of expandable discounts object list.

    • setDiscounts

      public void setDiscounts(List<String> ids)

    • getDiscountObjects

      public List<Discount> getDiscountObjects()
      Get expanded discounts.

    • setDiscountObjects

      public void setDiscountObjects(List<Discount> objs)

    • list

      public static QuotePreviewInvoiceCollection list(String quote, Map<String,Object> params) throws StripeException
      Preview the invoices that would be generated by accepting the quote.
      Throws:
      StripeException

    • list

      public static QuotePreviewInvoiceCollection list(String quote, Map<String,Object> params, RequestOptions options) throws StripeException
      Preview the invoices that would be generated by accepting the quote.
      Throws:
      StripeException

    • list

      public static QuotePreviewInvoiceCollection list(String quote, QuotePreviewInvoiceListParams params) throws StripeException
      Preview the invoices that would be generated by accepting the quote.
      Throws:
      StripeException

    • list

      public static QuotePreviewInvoiceCollection list(String quote, QuotePreviewInvoiceListParams params, RequestOptions options) throws StripeException
      Preview the invoices that would be generated by accepting the quote.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAccountCountry

      public String getAccountCountry()
      The country of the business associated with this invoice, most often the business creating the invoice.

    • getAccountName

      public String getAccountName()
      The public name of the business associated with this invoice, most often the business creating the invoice.

    • getAmountDue

      public Long getAmountDue()
      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.

    • getAmountOverpaid

      public Long getAmountOverpaid()
      Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.

    • getAmountPaid

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

    • getAmountRemaining

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

    • getAmountShipping

      public Long getAmountShipping()
      This is the sum of all the shipping amounts.

    • getAmountsDue

      public List<QuotePreviewInvoice.AmountsDue> getAmountsDue()
      List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.

    • getAppliesTo

      public QuotePreviewInvoice.AppliesTo getAppliesTo()

    • getAttemptCount

      public Long getAttemptCount()
      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.

    • getAttempted

      public Boolean getAttempted()
      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.

    • getAutomaticTax

      public QuotePreviewInvoice.AutomaticTax getAutomaticTax()

    • getAutomaticallyFinalizesAt

      public Long getAutomaticallyFinalizesAt()
      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.

    • getBillingReason

      public String getBillingReason()
      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.

      One of automatic_pending_invoice_item_invoice, manual, quote_accept, subscription, subscription_create, subscription_cycle, subscription_threshold, subscription_update, or upcoming.

    • getCollectionMethod

      public String getCollectionMethod()
      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.

      One of charge_automatically, or send_invoice.

    • getConfirmationSecret

      public QuotePreviewInvoice.ConfirmationSecret getConfirmationSecret()
      The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getCustomFields

      public List<QuotePreviewInvoice.CustomField> getCustomFields()
      Custom fields displayed on the invoice.

    • getCustomerAccount

      public String getCustomerAccount()
      The ID of the account who will be billed.

    • getCustomerAddress

      public Address getCustomerAddress()
      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.

    • getCustomerEmail

      public String getCustomerEmail()
      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.

    • getCustomerName

      public String getCustomerName()
      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.

    • getCustomerPhone

      public String getCustomerPhone()
      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.

    • getCustomerShipping

      public ShippingDetails getCustomerShipping()
      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.

    • getCustomerTaxExempt

      public String getCustomerTaxExempt()
      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.

      One of exempt, none, or reverse.

    • getCustomerTaxIds

      public List<QuotePreviewInvoice.CustomerTaxId> getCustomerTaxIds()
      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.

    • getDefaultTaxRates

      public List<TaxRate> getDefaultTaxRates()
      The tax rates applied to this invoice, if any.

    • getDescription

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.

    • getDueDate

      public Long getDueDate()
      The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.

    • getEffectiveAt

      public Long getEffectiveAt()
      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.

    • getEndingBalance

      public Long getEndingBalance()
      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.

    • getFooter

      public String getFooter()
      Footer displayed on the invoice.

    • getFromInvoice

      public QuotePreviewInvoice.FromInvoice getFromInvoice()
      Details of the invoice that was cloned. See the revision documentation for more details.

    • getIssuer

      public QuotePreviewInvoice.Issuer getIssuer()

    • getLastFinalizationError

      public StripeError getLastFinalizationError()
      The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.

    • getLines

      public InvoiceLineItemCollection getLines()
      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.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • getNextPaymentAttempt

      public Long getNextPaymentAttempt()
      The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.

    • getNumber

      public String getNumber()
      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.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to quote_preview_invoice.

    • getParent

      public QuotePreviewInvoice.Parent getParent()
      The parent that generated this invoice.

    • getPaymentSettings

      public QuotePreviewInvoice.PaymentSettings getPaymentSettings()

    • getPayments

      public InvoicePaymentCollection getPayments()
      Payments for this invoice.

    • getPeriodEnd

      public Long getPeriodEnd()
      End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price.

    • getPeriodStart

      public Long getPeriodStart()
      Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price.

    • getPostPaymentCreditNotesAmount

      public Long getPostPaymentCreditNotesAmount()
      Total amount of all post-payment credit notes issued for this invoice.

    • getPrePaymentCreditNotesAmount

      public Long getPrePaymentCreditNotesAmount()
      Total amount of all pre-payment credit notes issued for this invoice.

    • getReceiptNumber

      public String getReceiptNumber()
      This is the transaction number that appears on email receipts sent for this invoice.

    • getRendering

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

    • getShippingCost

      public QuotePreviewInvoice.ShippingCost getShippingCost()
      The details of the cost of shipping, including the ShippingRate applied on the invoice.

    • getShippingDetails

      public ShippingDetails getShippingDetails()
      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.

    • getStartingBalance

      public Long getStartingBalance()
      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.

    • getStatementDescriptor

      public String getStatementDescriptor()
      Extra information about an invoice for the customer's credit card statement.

    • getStatus

      public String getStatus()
      The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more

    • getStatusTransitions

      public QuotePreviewInvoice.StatusTransitions getStatusTransitions()

    • getSubtotal

      public Long getSubtotal()
      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

    • getSubtotalExcludingTax

      public Long getSubtotalExcludingTax()
      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

    • getThresholdReason

      public QuotePreviewInvoice.ThresholdReason getThresholdReason()

    • getTotal

      public Long getTotal()
      Total after discounts and taxes.

    • getTotalDiscountAmounts

      public List<QuotePreviewInvoice.TotalDiscountAmount> getTotalDiscountAmounts()
      The aggregate amounts calculated per discount across all line items.

    • getTotalExcludingTax

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

    • getTotalMarginAmounts

      public List<QuotePreviewInvoice.TotalMarginAmount> getTotalMarginAmounts()
      The aggregate amounts calculated per margin across all line items.

    • getTotalPretaxCreditAmounts

      public List<QuotePreviewInvoice.TotalPretaxCreditAmount> getTotalPretaxCreditAmounts()
      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.

    • getTotalTaxes

      public List<QuotePreviewInvoice.TotalTax> getTotalTaxes()
      The aggregate tax information of all line items.

    • getWebhooksDeliveredAt

      public Long getWebhooksDeliveredAt()
      Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.

    • setAccountCountry

      public void setAccountCountry(String accountCountry)
      The country of the business associated with this invoice, most often the business creating the invoice.

    • setAccountName

      public void setAccountName(String accountName)
      The public name of the business associated with this invoice, most often the business creating the invoice.

    • setAmountDue

      public void setAmountDue(Long amountDue)
      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.

    • setAmountOverpaid

      public void setAmountOverpaid(Long amountOverpaid)
      Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.

    • setAmountPaid

      public void setAmountPaid(Long amountPaid)
      The amount, in cents (or local equivalent), that was paid.

    • setAmountRemaining

      public void setAmountRemaining(Long amountRemaining)
      The difference between amount_due and amount_paid, in cents (or local equivalent).

    • setAmountShipping

      public void setAmountShipping(Long amountShipping)
      This is the sum of all the shipping amounts.

    • setAmountsDue

      public void setAmountsDue(List<QuotePreviewInvoice.AmountsDue> amountsDue)
      List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.

    • setAppliesTo

      public void setAppliesTo(QuotePreviewInvoice.AppliesTo appliesTo)

    • setAttemptCount

      public void setAttemptCount(Long attemptCount)
      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.

    • setAttempted

      public void setAttempted(Boolean attempted)
      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.

    • setAutomaticTax

      public void setAutomaticTax(QuotePreviewInvoice.AutomaticTax automaticTax)

    • setAutomaticallyFinalizesAt

      public void setAutomaticallyFinalizesAt(Long automaticallyFinalizesAt)
      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.

    • setBillingReason

      public void setBillingReason(String billingReason)
      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.

      One of automatic_pending_invoice_item_invoice, manual, quote_accept, subscription, subscription_create, subscription_cycle, subscription_threshold, subscription_update, or upcoming.

    • setCollectionMethod

      public void setCollectionMethod(String collectionMethod)
      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.

      One of charge_automatically, or send_invoice.

    • setConfirmationSecret

      public void setConfirmationSecret(QuotePreviewInvoice.ConfirmationSecret confirmationSecret)
      The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCurrency

      public void setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setCustomFields

      public void setCustomFields(List<QuotePreviewInvoice.CustomField> customFields)
      Custom fields displayed on the invoice.

    • setCustomerAccount

      public void setCustomerAccount(String customerAccount)
      The ID of the account who will be billed.

    • setCustomerAddress

      public void setCustomerAddress(Address customerAddress)
      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.

    • setCustomerEmail

      public void setCustomerEmail(String customerEmail)
      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.

    • setCustomerName

      public void setCustomerName(String customerName)
      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.

    • setCustomerPhone

      public void setCustomerPhone(String customerPhone)
      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.

    • setCustomerShipping

      public void setCustomerShipping(ShippingDetails customerShipping)
      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.

    • setCustomerTaxExempt

      public void setCustomerTaxExempt(String customerTaxExempt)
      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.

      One of exempt, none, or reverse.

    • setCustomerTaxIds

      public void setCustomerTaxIds(List<QuotePreviewInvoice.CustomerTaxId> customerTaxIds)
      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.

    • setDefaultTaxRates

      public void setDefaultTaxRates(List<TaxRate> defaultTaxRates)
      The tax rates applied to this invoice, if any.

    • setDescription

      public void setDescription(String description)
      An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.

    • setDueDate

      public void setDueDate(Long dueDate)
      The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.

    • setEffectiveAt

      public void setEffectiveAt(Long effectiveAt)
      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.

    • setEndingBalance

      public void setEndingBalance(Long endingBalance)
      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.

    • setFooter

      public void setFooter(String footer)
      Footer displayed on the invoice.

    • setFromInvoice

      public void setFromInvoice(QuotePreviewInvoice.FromInvoice fromInvoice)
      Details of the invoice that was cloned. See the revision documentation for more details.

    • setId

      public void setId(String id)
      Unique identifier for the object. For preview invoices created using the create preview endpoint, this id will be prefixed with upcoming_in.

    • setIssuer

      public void setIssuer(QuotePreviewInvoice.Issuer issuer)

    • setLastFinalizationError

      public void setLastFinalizationError(StripeError lastFinalizationError)
      The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.

    • setLines

      public void setLines(InvoiceLineItemCollection lines)
      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.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • setNextPaymentAttempt

      public void setNextPaymentAttempt(Long nextPaymentAttempt)
      The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.

    • setNumber

      public void setNumber(String number)
      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.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to quote_preview_invoice.

    • setParent

      public void setParent(QuotePreviewInvoice.Parent parent)
      The parent that generated this invoice.

    • setPaymentSettings

      public void setPaymentSettings(QuotePreviewInvoice.PaymentSettings paymentSettings)

    • setPayments

      public void setPayments(InvoicePaymentCollection payments)
      Payments for this invoice.

    • setPeriodEnd

      public void setPeriodEnd(Long periodEnd)
      End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price.

    • setPeriodStart

      public void setPeriodStart(Long periodStart)
      Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price.

    • setPostPaymentCreditNotesAmount

      public void setPostPaymentCreditNotesAmount(Long postPaymentCreditNotesAmount)
      Total amount of all post-payment credit notes issued for this invoice.

    • setPrePaymentCreditNotesAmount

      public void setPrePaymentCreditNotesAmount(Long prePaymentCreditNotesAmount)
      Total amount of all pre-payment credit notes issued for this invoice.

    • setReceiptNumber

      public void setReceiptNumber(String receiptNumber)
      This is the transaction number that appears on email receipts sent for this invoice.

    • setRendering

      public void setRendering(QuotePreviewInvoice.Rendering rendering)
      The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.

    • setShippingCost

      public void setShippingCost(QuotePreviewInvoice.ShippingCost shippingCost)
      The details of the cost of shipping, including the ShippingRate applied on the invoice.

    • setShippingDetails

      public void setShippingDetails(ShippingDetails shippingDetails)
      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.

    • setStartingBalance

      public void setStartingBalance(Long startingBalance)
      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.

    • setStatementDescriptor

      public void setStatementDescriptor(String statementDescriptor)
      Extra information about an invoice for the customer's credit card statement.

    • setStatus

      public void setStatus(String status)
      The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more

    • setStatusTransitions

      public void setStatusTransitions(QuotePreviewInvoice.StatusTransitions statusTransitions)

    • setSubtotal

      public void setSubtotal(Long subtotal)
      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

    • setSubtotalExcludingTax

      public void setSubtotalExcludingTax(Long subtotalExcludingTax)
      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

    • setThresholdReason

      public void setThresholdReason(QuotePreviewInvoice.ThresholdReason thresholdReason)

    • setTotal

      public void setTotal(Long total)
      Total after discounts and taxes.

    • setTotalDiscountAmounts

      public void setTotalDiscountAmounts(List<QuotePreviewInvoice.TotalDiscountAmount> totalDiscountAmounts)
      The aggregate amounts calculated per discount across all line items.

    • setTotalExcludingTax

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

    • setTotalMarginAmounts

      public void setTotalMarginAmounts(List<QuotePreviewInvoice.TotalMarginAmount> totalMarginAmounts)
      The aggregate amounts calculated per margin across all line items.

    • setTotalPretaxCreditAmounts

      public void setTotalPretaxCreditAmounts(List<QuotePreviewInvoice.TotalPretaxCreditAmount> totalPretaxCreditAmounts)
      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.

    • setTotalTaxes

      public void setTotalTaxes(List<QuotePreviewInvoice.TotalTax> totalTaxes)
      The aggregate tax information of all line items.

    • setWebhooksDeliveredAt

      public void setWebhooksDeliveredAt(Long webhooksDeliveredAt)
      Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object. For preview invoices created using the create preview endpoint, this id will be prefixed with upcoming_in.
      Specified by:
      getId in interface HasId