Class InvoiceUpdateParams


public class InvoiceUpdateParams extends ApiRequestParams
  • Method Details

    • builder

      public static InvoiceUpdateParams.Builder builder()
    • getAccountTaxIds

      public Object getAccountTaxIds()
      The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    • getApplicationFeeAmount

      public Long getApplicationFeeAmount()
      A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    • getAutoAdvance

      public Boolean getAutoAdvance()
      Controls whether Stripe performs automatic collection of the invoice.
    • getAutomaticTax

      public InvoiceUpdateParams.AutomaticTax getAutomaticTax()
      Settings for automatic tax lookup for this invoice.
    • getCollectionMethod

      public InvoiceUpdateParams.CollectionMethod getCollectionMethod()
      Either charge_automatically or send_invoice. This field can be updated only on draft invoices.
    • getCustomFields

      public Object getCustomFields()
      A list of up to 4 custom fields to be displayed on the invoice. If a value for custom_fields is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.
    • getDaysUntilDue

      public Long getDaysUntilDue()
      The number of days from which the invoice is created until it is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.
    • getDefaultPaymentMethod

      public Object getDefaultPaymentMethod()
      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.
    • getDefaultSource

      public Object getDefaultSource()
      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.
    • getDefaultTaxRates

      public Object getDefaultTaxRates()
      The tax rates that will apply to any line item that does not have tax_rates set. Pass an empty string to remove previously-defined tax rates.
    • getDescription

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

      public Object getDiscounts()
      The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.
    • getDueDate

      public Long getDueDate()
      The date on which payment for this invoice is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.
    • getEffectiveAt

      public Object 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.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getFooter

      public Object getFooter()
      Footer to be displayed on the invoice.
    • getMetadata

      public Object 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    • getOnBehalfOf

      public Object getOnBehalfOf()
      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 documentation for details.
    • getPaymentSettings

      public InvoiceUpdateParams.PaymentSettings getPaymentSettings()
      Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
    • getRendering

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

      public Object getRenderingOptions()
      This is a legacy field that will be removed soon. For details about rendering_options, refer to rendering instead. Options for invoice PDF rendering.
    • getShippingCost

      public Object getShippingCost()
      Settings for the cost of shipping for this invoice.
    • getShippingDetails

      public Object 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.
    • getStatementDescriptor

      public Object getStatementDescriptor()
      Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default statement_descriptor will be set to the first subscription item's product's statement_descriptor.
    • getTransferData

      public Object getTransferData()
      If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value.