com.stripe.param

Class InvoiceCreateParams.Builder

java.lang.Object

com.stripe.param.InvoiceCreateParams.Builder

Enclosing class:

InvoiceCreateParams

public static class InvoiceCreateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
InvoiceCreateParams.Builder	addAllCustomField(java.util.List<InvoiceCreateParams.CustomField> elements) Add all elements to `customFields` list.
InvoiceCreateParams.Builder	addAllDefaultTaxRate(java.util.List<java.lang.String> elements) Add all elements to `defaultTaxRates` list.
InvoiceCreateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
InvoiceCreateParams.Builder	addCustomField(InvoiceCreateParams.CustomField element) Add an element to `customFields` list.
InvoiceCreateParams.Builder	addDefaultTaxRate(java.lang.String element) Add an element to `defaultTaxRates` list.
InvoiceCreateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
InvoiceCreateParams	build() Finalize and obtain parameter instance from this builder.
InvoiceCreateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
InvoiceCreateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
InvoiceCreateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
InvoiceCreateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
InvoiceCreateParams.Builder	setApplicationFeeAmount(java.lang.Long applicationFeeAmount) A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account.
InvoiceCreateParams.Builder	setAutoAdvance(java.lang.Boolean autoAdvance) Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice.
InvoiceCreateParams.Builder	setCollectionMethod(InvoiceCreateParams.CollectionMethod collectionMethod) Either `charge_automatically`, or `send_invoice`.
InvoiceCreateParams.Builder	setCustomer(java.lang.String customer) The ID of the customer who will be billed.
InvoiceCreateParams.Builder	setCustomFields(EmptyParam customFields) A list of up to 4 custom fields to be displayed on the invoice.
InvoiceCreateParams.Builder	setCustomFields(java.util.List<InvoiceCreateParams.CustomField> customFields) A list of up to 4 custom fields to be displayed on the invoice.
InvoiceCreateParams.Builder	setDaysUntilDue(java.lang.Long daysUntilDue) The number of days from when the invoice is created until it is due.
InvoiceCreateParams.Builder	setDefaultPaymentMethod(java.lang.String defaultPaymentMethod) ID of the default payment method for the invoice.
InvoiceCreateParams.Builder	setDefaultSource(java.lang.String defaultSource) ID of the default payment source for the invoice.
InvoiceCreateParams.Builder	setDescription(java.lang.String description) An arbitrary string attached to the object.
InvoiceCreateParams.Builder	setDueDate(java.lang.Long dueDate) The date on which payment for this invoice is due.
InvoiceCreateParams.Builder	setFooter(java.lang.String footer) Footer to be displayed on the invoice.
InvoiceCreateParams.Builder	setStatementDescriptor(java.lang.String statementDescriptor) Extra information about a charge for the customer's credit card statement.
InvoiceCreateParams.Builder	setSubscription(java.lang.String subscription) The ID of the subscription to invoice, if any.
InvoiceCreateParams.Builder	setTaxPercent(java.math.BigDecimal taxPercent) The percent tax rate applied to the invoice, represented as a decimal number.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

build

public InvoiceCreateParams build()

Finalize and obtain parameter instance from this builder.

setApplicationFeeAmount

public InvoiceCreateParams.Builder setApplicationFeeAmount(java.lang.Long applicationFeeAmount)

A fee in %s 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](https://stripe.com/docs/connect/subscriptions#invoices).

setAutoAdvance

public InvoiceCreateParams.Builder setAutoAdvance(java.lang.Boolean autoAdvance)

Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.

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`.

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(java.util.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(java.util.List<InvoiceCreateParams.CustomField> customFields)

A list of up to 4 custom fields to be displayed on the invoice.

setCustomer

public InvoiceCreateParams.Builder setCustomer(java.lang.String customer)

The ID of the customer who will be billed.

setDaysUntilDue

public InvoiceCreateParams.Builder setDaysUntilDue(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.util.List<java.lang.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(java.lang.String description)

An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.

setDueDate

public InvoiceCreateParams.Builder setDueDate(java.lang.Long dueDate)

The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.

addExpand

public InvoiceCreateParams.Builder addExpand(java.lang.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(java.util.List<java.lang.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(java.lang.String key,
                                                 java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.String footer)

Footer to be displayed on the invoice.

putMetadata

public InvoiceCreateParams.Builder putMetadata(java.lang.String key,
                                               java.lang.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(java.util.Map<java.lang.String,java.lang.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.

setStatementDescriptor

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

The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected.

setTaxPercent

public InvoiceCreateParams.Builder setTaxPercent(java.math.BigDecimal taxPercent)

The percent tax rate applied to the invoice, represented as a decimal number. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`.

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. This will be unset if you POST an empty value.