Class InvoiceCreateParams


public class InvoiceCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static InvoiceCreateParams.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. If false, the invoice's state doesn't automatically advance without an explicit action.
    • getAutomaticTax

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

      public InvoiceCreateParams.CollectionMethod 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. Defaults to charge_automatically.
    • getCurrency

      public String getCurrency()
      The currency to create this invoice in. Defaults to that of customer if not specified.
    • getCustomFields

      public Object getCustomFields()
      A list of up to 4 custom fields to be displayed on the invoice.
    • getCustomer

      public String getCustomer()
      The ID of the customer who will be billed.
    • getDaysUntilDue

      public Long getDaysUntilDue()
      The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    • getDefaultPaymentMethod

      public String 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 String 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 List<String> getDefaultTaxRates()
      The tax rates that will apply to any line item that does not have tax_rates set.
    • getDescription

      public String 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 coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.
    • getDueDate

      public Long getDueDate()
      The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice.
    • 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.
    • 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 String getFooter()
      Footer to be displayed on the invoice.
    • getFromInvoice

      public InvoiceCreateParams.FromInvoice getFromInvoice()
      Revise an existing invoice. The new invoice will be created in status=draft. See the revision documentation for more details.
    • getIssuer

      public InvoiceCreateParams.Issuer getIssuer()
      The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    • 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.
    • getNumber

      public String getNumber()
      Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
    • getOnBehalfOf

      public String 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 InvoiceCreateParams.PaymentSettings getPaymentSettings()
      Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
    • getPendingInvoiceItemsBehavior

      public InvoiceCreateParams.PendingInvoiceItemsBehavior getPendingInvoiceItemsBehavior()
      How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    • getRendering

      public InvoiceCreateParams.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 InvoiceCreateParams.ShippingCost getShippingCost()
      Settings for the cost of shipping for this invoice.
    • getShippingDetails

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

      public String 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.
    • getSubscription

      public String getSubscription()
      The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.
    • getTransferData

      public InvoiceCreateParams.TransferData 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.