Package com.stripe.param
Class InvoiceCreateParams.Builder
java.lang.Object
com.stripe.param.InvoiceCreateParams.Builder
- Enclosing class:
InvoiceCreateParams
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAccountTaxId
(String element) Add an element to `accountTaxIds` list.addAllAccountTaxId
(List<String> elements) Add all elements to `accountTaxIds` list.addAllCustomField
(List<InvoiceCreateParams.CustomField> elements) Add all elements to `customFields` list.addAllDefaultTaxRate
(List<String> elements) Add all elements to `defaultTaxRates` list.addAllDiscount
(List<InvoiceCreateParams.Discount> elements) Add all elements to `discounts` list.addAllExpand
(List<String> elements) Add all elements to `expand` list.Add an element to `customFields` list.addDefaultTaxRate
(String element) Add an element to `defaultTaxRates` list.addDiscount
(InvoiceCreateParams.Discount element) Add an element to `discounts` list.Add an element to `expand` list.build()
Finalize and obtain parameter instance from this builder.putAllExtraParam
(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putAllMetadata
(Map<String, String> map) Add all map key/value pairs to `metadata` map.putExtraParam
(String key, Object value) Add a key/value pair to `extraParams` map.putMetadata
(String key, String value) Add a key/value pair to `metadata` map.setAccountTaxIds
(EmptyParam accountTaxIds) The account tax IDs associated with the invoice.setAccountTaxIds
(List<String> accountTaxIds) The account tax IDs associated with the invoice.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.setAutoAdvance
(Boolean autoAdvance) Controls whether Stripe will perform automatic collection of the invoice.setAutomaticTax
(InvoiceCreateParams.AutomaticTax automaticTax) Settings for automatic tax lookup for this invoice.setCollectionMethod
(InvoiceCreateParams.CollectionMethod collectionMethod) Eithercharge_automatically
, orsend_invoice
.setCustomer
(String customer) The ID of the customer who will be billed.setCustomFields
(EmptyParam customFields) A list of up to 4 custom fields to be displayed on the invoice.setCustomFields
(List<InvoiceCreateParams.CustomField> customFields) A list of up to 4 custom fields to be displayed on the invoice.setDaysUntilDue
(Long daysUntilDue) The number of days from when the invoice is created until it is due.setDefaultPaymentMethod
(String defaultPaymentMethod) ID of the default payment method for the invoice.setDefaultSource
(String defaultSource) ID of the default payment source for the invoice.setDescription
(String description) An arbitrary string attached to the object.setDiscounts
(EmptyParam discounts) The coupons to redeem into discounts for the invoice.setDiscounts
(List<InvoiceCreateParams.Discount> discounts) The coupons to redeem into discounts for the invoice.setDueDate
(Long dueDate) The date on which payment for this invoice is due.Footer to be displayed on the invoice.setMetadata
(EmptyParam metadata) Set of key-value pairs that you can attach to an object.setMetadata
(Map<String, String> metadata) Set of key-value pairs that you can attach to an object.setOnBehalfOf
(String onBehalfOf) The account (if any) for which the funds of the invoice payment are intended.setPaymentSettings
(InvoiceCreateParams.PaymentSettings paymentSettings) Configuration settings for the PaymentIntent that is generated when the invoice is finalized.setPendingInvoiceItemsBehavior
(InvoiceCreateParams.PendingInvoiceItemsBehavior pendingInvoiceItemsBehavior) How to handle pending invoice items on invoice creation.setStatementDescriptor
(String statementDescriptor) Extra information about a charge for the customer's credit card statement.setSubscription
(String subscription) The ID of the subscription to invoice, if any.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.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
addAccountTaxId
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. SeeInvoiceCreateParams.accountTaxIds
for the field documentation. -
addAllAccountTaxId
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. SeeInvoiceCreateParams.accountTaxIds
for the field documentation. -
setAccountTaxIds
The account tax IDs associated with the invoice. Only editable when the invoice is a draft. -
setAccountTaxIds
The account tax IDs associated with the invoice. Only editable when the invoice is a draft. -
setApplicationFeeAmount
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
Controls whether Stripe will perform automatic collection of the invoice. Whenfalse
, the invoice's state will not automatically advance without an explicit action. -
setAutomaticTax
Settings for automatic tax lookup for this invoice. -
setCollectionMethod
public InvoiceCreateParams.Builder setCollectionMethod(InvoiceCreateParams.CollectionMethod collectionMethod) Eithercharge_automatically
, orsend_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 tocharge_automatically
. -
addCustomField
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. SeeInvoiceCreateParams.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. SeeInvoiceCreateParams.customFields
for the field documentation. -
setCustomFields
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
The ID of the customer who will be billed. -
setDaysUntilDue
The number of days from when the invoice is created until it is due. Valid only for invoices wherecollection_method=send_invoice
. -
setDefaultPaymentMethod
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
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
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. SeeInvoiceCreateParams.defaultTaxRates
for the field documentation. -
addAllDefaultTaxRate
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. SeeInvoiceCreateParams.defaultTaxRates
for the field documentation. -
setDescription
An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. -
addDiscount
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. SeeInvoiceCreateParams.discounts
for the field documentation. -
addAllDiscount
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. SeeInvoiceCreateParams.discounts
for the field documentation. -
setDiscounts
The coupons 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
The coupons 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
The date on which payment for this invoice is due. Valid only for invoices wherecollection_method=send_invoice
. -
addExpand
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. SeeInvoiceCreateParams.expand
for the field documentation. -
addAllExpand
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. SeeInvoiceCreateParams.expand
for the field documentation. -
putExtraParam
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. SeeInvoiceCreateParams.extraParams
for the field documentation. -
putAllExtraParam
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. SeeInvoiceCreateParams.extraParams
for the field documentation. -
putMetadata
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. SeeInvoiceCreateParams.metadata
for the field documentation. -
putAllMetadata
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. SeeInvoiceCreateParams.metadata
for the field documentation. -
setMetadata
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 tometadata
. -
setMetadata
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 tometadata
. -
setOnBehalfOf
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. One ofinclude
,exclude
, orinclude_and_require
.include
will include any pending invoice items, and will create an empty draft invoice if no pending invoice items exist.include_and_require
will include any pending invoice items, if no pending invoice items exist then the request will fail.exclude
will always create an empty invoice draft regardless if there are pending invoice items or not. Defaults toinclude_and_require
if the parameter is omitted. -
setStatementDescriptor
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 defaultstatement_descriptor
will be set to the first subscription item's product'sstatement_descriptor
. -
setSubscription
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. -
setTransferData
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.
-