public class InvoiceCreateParams extends ApiRequestParams
Modifier and Type | Class and Description |
---|---|
static class |
InvoiceCreateParams.Builder |
static class |
InvoiceCreateParams.CollectionMethod
Add all map key/value pairs to `extraParams` map.
|
static class |
InvoiceCreateParams.CustomField |
static class |
InvoiceCreateParams.Discount
The value of the custom field.
|
static class |
InvoiceCreateParams.TransferData
Add all map key/value pairs to `extraParams` map.
|
ApiRequestParams.EnumParam
EXTRA_PARAMS_KEY
Modifier and Type | Method and Description |
---|---|
static InvoiceCreateParams.Builder |
builder() |
java.lang.Long |
getApplicationFeeAmount()
A fee in %s that will be applied to the invoice and transferred to the application owner's
Stripe account.
|
java.lang.Boolean |
getAutoAdvance()
Controls whether Stripe will perform automatic collection
of the invoice.
|
InvoiceCreateParams.CollectionMethod |
getCollectionMethod()
Either
charge_automatically , or send_invoice . |
java.lang.String |
getCustomer()
The ID of the customer who will be billed.
|
java.lang.Object |
getCustomFields()
A list of up to 4 custom fields to be displayed on the invoice.
|
java.lang.Long |
getDaysUntilDue()
The number of days from when the invoice is created until it is due.
|
java.lang.String |
getDefaultPaymentMethod()
ID of the default payment method for the invoice.
|
java.lang.String |
getDefaultSource()
ID of the default payment source for the invoice.
|
java.util.List<java.lang.String> |
getDefaultTaxRates()
The tax rates that will apply to any line item that does not have
tax_rates set. |
java.lang.String |
getDescription()
An arbitrary string attached to the object.
|
java.lang.Object |
getDiscounts()
The coupons to redeem into discounts for the invoice.
|
java.lang.Long |
getDueDate()
The date on which payment for this invoice is due.
|
java.util.List<java.lang.String> |
getExpand()
Specifies which fields in the response should be expanded.
|
java.util.Map<java.lang.String,java.lang.Object> |
getExtraParams()
Map of extra parameters for custom features not available in this client library.
|
java.lang.String |
getFooter()
Footer to be displayed on the invoice.
|
java.lang.Object |
getMetadata()
Set of key-value pairs that you can attach
to an object.
|
java.lang.String |
getStatementDescriptor()
Extra information about a charge for the customer's credit card statement.
|
java.lang.String |
getSubscription()
The ID of the subscription to invoice, if any.
|
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.
|
toMap
public static InvoiceCreateParams.Builder builder()
public java.lang.Long getApplicationFeeAmount()
public java.lang.Boolean getAutoAdvance()
false
, the invoice's state will not automatically advance without
an explicit action.public InvoiceCreateParams.CollectionMethod getCollectionMethod()
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
.public java.lang.Object getCustomFields()
public java.lang.String getCustomer()
public java.lang.Long getDaysUntilDue()
collection_method=send_invoice
.public java.lang.String getDefaultPaymentMethod()
public java.lang.String getDefaultSource()
public java.util.List<java.lang.String> getDefaultTaxRates()
tax_rates
set.public java.lang.String getDescription()
public java.lang.Object getDiscounts()
public java.lang.Long getDueDate()
collection_method=send_invoice
.public java.util.List<java.lang.String> getExpand()
public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()
@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.public java.lang.String getFooter()
public java.lang.Object getMetadata()
metadata
.public java.lang.String getStatementDescriptor()
statement_descriptor
will be set to the first subscription item's product's statement_descriptor
.public java.lang.String getSubscription()
public InvoiceCreateParams.TransferData getTransferData()