Package com.stripe.param

Class InvoiceUpdateParams.Builder

java.lang.Object
com.stripe.param.InvoiceUpdateParams.Builder
Enclosing class:
InvoiceUpdateParams
public static class InvoiceUpdateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public InvoiceUpdateParams build()
      Finalize and obtain parameter instance from this builder.

    • addAccountTaxId

      public InvoiceUpdateParams.Builder addAccountTaxId(String element)
      Add an element to `accountTaxIds` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.accountTaxIds for the field documentation.

    • addAllAccountTaxId

      public InvoiceUpdateParams.Builder addAllAccountTaxId(List<String> elements)
      Add all elements to `accountTaxIds` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.accountTaxIds for the field documentation.

    • setAccountTaxIds

      public InvoiceUpdateParams.Builder setAccountTaxIds(EmptyParam accountTaxIds)
      The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

    • setAccountTaxIds

      public InvoiceUpdateParams.Builder setAccountTaxIds(List<String> accountTaxIds)
      The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

    • setApplicationFeeAmount

      public InvoiceUpdateParams.Builder setApplicationFeeAmount(Long applicationFeeAmount)
      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.

    • setAutoAdvance

      public InvoiceUpdateParams.Builder setAutoAdvance(Boolean autoAdvance)
      Controls whether Stripe performs automatic collection of the invoice.

    • setAutomaticTax

      public InvoiceUpdateParams.Builder setAutomaticTax(InvoiceUpdateParams.AutomaticTax automaticTax)
      Settings for automatic tax lookup for this invoice.

    • setCollectionMethod

      public InvoiceUpdateParams.Builder setCollectionMethod(InvoiceUpdateParams.CollectionMethod collectionMethod)
      Either charge_automatically or send_invoice. This field can be updated only on draft invoices.

    • addCustomField

      public InvoiceUpdateParams.Builder addCustomField(InvoiceUpdateParams.CustomField element)
      Add an element to `customFields` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.customFields for the field documentation.

    • addAllCustomField

      public InvoiceUpdateParams.Builder addAllCustomField(List<InvoiceUpdateParams.CustomField> elements)
      Add all elements to `customFields` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.customFields for the field documentation.

    • setCustomFields

      public InvoiceUpdateParams.Builder setCustomFields(EmptyParam customFields)
      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.

    • setCustomFields

      public InvoiceUpdateParams.Builder setCustomFields(List<InvoiceUpdateParams.CustomField> customFields)
      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.

    • setDaysUntilDue

      public InvoiceUpdateParams.Builder setDaysUntilDue(Long daysUntilDue)
      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.

    • setDefaultPaymentMethod

      public InvoiceUpdateParams.Builder setDefaultPaymentMethod(String defaultPaymentMethod)
      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.

    • setDefaultPaymentMethod

      public InvoiceUpdateParams.Builder setDefaultPaymentMethod(EmptyParam defaultPaymentMethod)
      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.

    • setDefaultSource

      public InvoiceUpdateParams.Builder setDefaultSource(String defaultSource)
      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.

    • setDefaultSource

      public InvoiceUpdateParams.Builder setDefaultSource(EmptyParam defaultSource)
      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.

    • addDefaultTaxRate

      public InvoiceUpdateParams.Builder addDefaultTaxRate(String element)
      Add an element to `defaultTaxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.defaultTaxRates for the field documentation.

    • addAllDefaultTaxRate

      public InvoiceUpdateParams.Builder addAllDefaultTaxRate(List<String> elements)
      Add all elements to `defaultTaxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.defaultTaxRates for the field documentation.

    • setDefaultTaxRates

      public InvoiceUpdateParams.Builder setDefaultTaxRates(EmptyParam defaultTaxRates)
      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.

    • setDefaultTaxRates

      public InvoiceUpdateParams.Builder setDefaultTaxRates(List<String> defaultTaxRates)
      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.

    • setDescription

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

    • setDescription

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

    • addDiscount

      public InvoiceUpdateParams.Builder addDiscount(InvoiceUpdateParams.Discount element)
      Add an element to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.discounts for the field documentation.

    • addAllDiscount

      public InvoiceUpdateParams.Builder addAllDiscount(List<InvoiceUpdateParams.Discount> elements)
      Add all elements to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.discounts for the field documentation.

    • setDiscounts

      public InvoiceUpdateParams.Builder setDiscounts(EmptyParam discounts)
      The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.

    • setDiscounts

      public InvoiceUpdateParams.Builder setDiscounts(List<InvoiceUpdateParams.Discount> discounts)
      The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.

    • setDueDate

      public InvoiceUpdateParams.Builder setDueDate(Long dueDate)
      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.

    • setEffectiveAt

      public InvoiceUpdateParams.Builder 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.

    • setEffectiveAt

      public InvoiceUpdateParams.Builder setEffectiveAt(EmptyParam 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.

    • addExpand

      public InvoiceUpdateParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.expand for the field documentation.

    • addAllExpand

      public InvoiceUpdateParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpdateParams.expand for the field documentation.

    • putExtraParam

      public InvoiceUpdateParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See InvoiceUpdateParams.extraParams for the field documentation.

    • putAllExtraParam

      public InvoiceUpdateParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See InvoiceUpdateParams.extraParams for the field documentation.

    • setFooter

      public InvoiceUpdateParams.Builder setFooter(String footer)
      Footer to be displayed on the invoice.

    • setFooter

      public InvoiceUpdateParams.Builder setFooter(EmptyParam footer)
      Footer to be displayed on the invoice.

    • setIssuer

      public InvoiceUpdateParams.Builder setIssuer(InvoiceUpdateParams.Issuer issuer)
      The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

    • putMetadata

      public InvoiceUpdateParams.Builder putMetadata(String key, String value)
      Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See InvoiceUpdateParams.metadata for the field documentation.

    • putAllMetadata

      public InvoiceUpdateParams.Builder putAllMetadata(Map<String,String> map)
      Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See InvoiceUpdateParams.metadata for the field documentation.

    • setMetadata

      public InvoiceUpdateParams.Builder setMetadata(EmptyParam 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • setMetadata

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

    • setNumber

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

    • setNumber

      public InvoiceUpdateParams.Builder setNumber(EmptyParam number)
      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.

    • setOnBehalfOf

      public InvoiceUpdateParams.Builder setOnBehalfOf(String onBehalfOf)
      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.

    • setOnBehalfOf

      public InvoiceUpdateParams.Builder setOnBehalfOf(EmptyParam onBehalfOf)
      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.

    • setPaymentSettings

      public InvoiceUpdateParams.Builder setPaymentSettings(InvoiceUpdateParams.PaymentSettings paymentSettings)
      Configuration settings for the PaymentIntent that is generated when the invoice is finalized.

    • setRendering

      public InvoiceUpdateParams.Builder setRendering(InvoiceUpdateParams.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 InvoiceUpdateParams.Builder setShippingCost(InvoiceUpdateParams.ShippingCost shippingCost)
      Settings for the cost of shipping for this invoice.

    • setShippingCost

      public InvoiceUpdateParams.Builder setShippingCost(EmptyParam shippingCost)
      Settings for the cost of shipping for this invoice.

    • setShippingDetails

      public InvoiceUpdateParams.Builder setShippingDetails(InvoiceUpdateParams.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.

    • setShippingDetails

      public InvoiceUpdateParams.Builder setShippingDetails(EmptyParam 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.

    • setStatementDescriptor

      public InvoiceUpdateParams.Builder setStatementDescriptor(String statementDescriptor)
      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.

    • setStatementDescriptor

      public InvoiceUpdateParams.Builder setStatementDescriptor(EmptyParam statementDescriptor)
      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.

    • setTransferData

      public InvoiceUpdateParams.Builder setTransferData(InvoiceUpdateParams.TransferData transferData)
      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.

    • setTransferData

      public InvoiceUpdateParams.Builder setTransferData(EmptyParam transferData)
      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.