Package com.stripe.param

Class InvoiceCreateParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • addAccountTaxId

      public InvoiceCreateParams.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 InvoiceCreateParams.accountTaxIds for the field documentation.

    • addAllAccountTaxId

      public InvoiceCreateParams.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 InvoiceCreateParams.accountTaxIds for the field documentation.

    • setAccountTaxIds

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

    • setAccountTaxIds

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

    • setApplicationFeeAmount

      public InvoiceCreateParams.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 InvoiceCreateParams.Builder setAutoAdvance(Boolean autoAdvance)
      Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.

    • setAutomaticTax

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

    • setCollectionMethod

      public InvoiceCreateParams.Builder setCollectionMethod(InvoiceCreateParams.CollectionMethod 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. Defaults to charge_automatically.

    • setCurrency

      public InvoiceCreateParams.Builder setCurrency(String currency)
      The currency to create this invoice in. Defaults to that of customer if not specified.

    • addCustomField

      public InvoiceCreateParams.Builder addCustomField(InvoiceCreateParams.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 InvoiceCreateParams.customFields for the field documentation.

    • addAllCustomField

      public InvoiceCreateParams.Builder addAllCustomField(List<InvoiceCreateParams.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 InvoiceCreateParams.customFields for the field documentation.

    • setCustomFields

      public InvoiceCreateParams.Builder setCustomFields(EmptyParam customFields)
      A list of up to 4 custom fields to be displayed on the invoice.

    • setCustomFields

      public InvoiceCreateParams.Builder setCustomFields(List<InvoiceCreateParams.CustomField> customFields)
      A list of up to 4 custom fields to be displayed on the invoice.

    • setCustomer

      public InvoiceCreateParams.Builder setCustomer(String customer)
      The ID of the customer who will be billed.

    • setDaysUntilDue

      public InvoiceCreateParams.Builder setDaysUntilDue(Long daysUntilDue)
      The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.

    • setDefaultPaymentMethod

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

    • setDefaultSource

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

    • addDefaultTaxRate

      public InvoiceCreateParams.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 InvoiceCreateParams.defaultTaxRates for the field documentation.

    • addAllDefaultTaxRate

      public InvoiceCreateParams.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 InvoiceCreateParams.defaultTaxRates for the field documentation.

    • setDescription

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

    • addDiscount

      public InvoiceCreateParams.Builder addDiscount(InvoiceCreateParams.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 InvoiceCreateParams.discounts for the field documentation.

    • addAllDiscount

      public InvoiceCreateParams.Builder addAllDiscount(List<InvoiceCreateParams.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 InvoiceCreateParams.discounts for the field documentation.

    • setDiscounts

      public InvoiceCreateParams.Builder setDiscounts(EmptyParam discounts)
      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.

    • setDiscounts

      public InvoiceCreateParams.Builder setDiscounts(List<InvoiceCreateParams.Discount> discounts)
      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.

    • setDueDate

      public InvoiceCreateParams.Builder setDueDate(Long dueDate)
      The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice.

    • setEffectiveAt

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

    • addExpand

      public InvoiceCreateParams.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 InvoiceCreateParams.expand for the field documentation.

    • addAllExpand

      public InvoiceCreateParams.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 InvoiceCreateParams.expand for the field documentation.

    • putExtraParam

      public InvoiceCreateParams.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 InvoiceCreateParams.extraParams for the field documentation.

    • putAllExtraParam

      public InvoiceCreateParams.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 InvoiceCreateParams.extraParams for the field documentation.

    • setFooter

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

    • setFromInvoice

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

    • setIssuer

      public InvoiceCreateParams.Builder setIssuer(InvoiceCreateParams.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 InvoiceCreateParams.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 InvoiceCreateParams.metadata for the field documentation.

    • putAllMetadata

      public InvoiceCreateParams.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 InvoiceCreateParams.metadata for the field documentation.

    • setMetadata

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

    • setOnBehalfOf

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

    • setPaymentSettings

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

    • setPendingInvoiceItemsBehavior

      public InvoiceCreateParams.Builder setPendingInvoiceItemsBehavior(InvoiceCreateParams.PendingInvoiceItemsBehavior pendingInvoiceItemsBehavior)
      How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.

    • setRendering

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

    • setShippingDetails

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

    • setStatementDescriptor

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

    • setSubscription

      public InvoiceCreateParams.Builder setSubscription(String subscription)
      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.

    • setTransferData

      public InvoiceCreateParams.Builder setTransferData(InvoiceCreateParams.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.