Package com.stripe.model
Class Quote
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.Quote
-
- All Implemented Interfaces:
HasId
,MetadataStore<Quote>
,StripeObjectInterface
public class Quote extends ApiResource implements HasId, MetadataStore<Quote>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Quote.AutomaticTax
static class
Quote.Computed
static class
Quote.FromQuote
static class
Quote.InvoiceSettings
static class
Quote.Recurring
static class
Quote.StatusTransitions
static class
Quote.SubscriptionData
static class
Quote.TotalDetails
static class
Quote.TransferData
The aggregated line item tax amounts by rate.static class
Quote.Upfront
-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description Quote()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Quote
accept()
Accepts the specified quote.Quote
accept(RequestOptions options)
Accepts the specified quote.Quote
accept(QuoteAcceptParams params)
Accepts the specified quote.Quote
accept(QuoteAcceptParams params, RequestOptions options)
Accepts the specified quote.Quote
accept(java.util.Map<java.lang.String,java.lang.Object> params)
Accepts the specified quote.Quote
accept(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Accepts the specified quote.Quote
cancel()
Cancels the quote.Quote
cancel(RequestOptions options)
Cancels the quote.Quote
cancel(QuoteCancelParams params)
Cancels the quote.Quote
cancel(QuoteCancelParams params, RequestOptions options)
Cancels the quote.Quote
cancel(java.util.Map<java.lang.String,java.lang.Object> params)
Cancels the quote.Quote
cancel(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Cancels the quote.protected boolean
canEqual(java.lang.Object other)
static Quote
create(QuoteCreateParams params)
A quote models prices and services for a customer.static Quote
create(QuoteCreateParams params, RequestOptions options)
A quote models prices and services for a customer.static Quote
create(java.util.Map<java.lang.String,java.lang.Object> params)
A quote models prices and services for a customer.static Quote
create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
A quote models prices and services for a customer.boolean
equals(java.lang.Object o)
Quote
finalizeQuote()
Finalizes the quote.Quote
finalizeQuote(RequestOptions options)
Finalizes the quote.Quote
finalizeQuote(QuoteFinalizeQuoteParams params)
Finalizes the quote.Quote
finalizeQuote(QuoteFinalizeQuoteParams params, RequestOptions options)
Finalizes the quote.Quote
finalizeQuote(java.util.Map<java.lang.String,java.lang.Object> params)
Finalizes the quote.Quote
finalizeQuote(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Finalizes the quote.java.lang.Long
getAmountSubtotal()
Total before any discounts or taxes are applied.java.lang.Long
getAmountTotal()
Total after discounts and taxes are applied.java.lang.Long
getApplicationFeeAmount()
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.java.math.BigDecimal
getApplicationFeePercent()
A non-negative decimal between 0 and 100, with at most two decimal places.Quote.AutomaticTax
getAutomaticTax()
java.lang.String
getCollectionMethod()
Eithercharge_automatically
, orsend_invoice
.Quote.Computed
getComputed()
java.lang.Long
getCreated()
Time at which the object was created.java.lang.String
getCurrency()
Three-letter ISO currency code, in lowercase.java.lang.String
getCustomer()
Get ID of expandablecustomer
object.Customer
getCustomerObject()
Get expandedcustomer
.java.util.List<TaxRate>
getDefaultTaxRateObjects()
Get expandeddefaultTaxRates
.java.util.List<java.lang.String>
getDefaultTaxRates()
Get IDs of expandabledefaultTaxRates
object list.java.lang.String
getDescription()
A description that will be displayed on the quote PDF.java.util.List<Discount>
getDiscountObjects()
Get expandeddiscounts
.java.util.List<java.lang.String>
getDiscounts()
Get IDs of expandablediscounts
object list.java.lang.Long
getExpiresAt()
The date on which the quote will be canceled if inopen
ordraft
status.java.lang.String
getFooter()
A footer that will be displayed on the quote PDF.Quote.FromQuote
getFromQuote()
Details of the quote that was cloned.java.lang.String
getHeader()
A header that will be displayed on the quote PDF.java.lang.String
getId()
Unique identifier for the object.java.lang.String
getInvoice()
Get ID of expandableinvoice
object.Invoice
getInvoiceObject()
Get expandedinvoice
.Quote.InvoiceSettings
getInvoiceSettings()
All invoices will be billed using the specified settings.LineItemCollection
getLineItems()
A list of items the customer is being quoted for.java.lang.Boolean
getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getNumber()
A unique number that identifies this particular quote.java.lang.String
getObject()
String representing the object's type.java.lang.String
getOnBehalfOf()
Get ID of expandableonBehalfOf
object.Account
getOnBehalfOfObject()
Get expandedonBehalfOf
.java.lang.String
getStatus()
The status of the quote.Quote.StatusTransitions
getStatusTransitions()
java.lang.String
getSubscription()
Get ID of expandablesubscription
object.Quote.SubscriptionData
getSubscriptionData()
Subscription
getSubscriptionObject()
Get expandedsubscription
.java.lang.String
getSubscriptionSchedule()
Get ID of expandablesubscriptionSchedule
object.SubscriptionSchedule
getSubscriptionScheduleObject()
Get expandedsubscriptionSchedule
.Quote.TotalDetails
getTotalDetails()
Quote.TransferData
getTransferData()
The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.int
hashCode()
static QuoteCollection
list(QuoteListParams params)
Returns a list of your quotes.static QuoteCollection
list(QuoteListParams params, RequestOptions options)
Returns a list of your quotes.static QuoteCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of your quotes.static QuoteCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list of your quotes.LineItemCollection
listComputedUpfrontLineItems()
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items.LineItemCollection
listComputedUpfrontLineItems(QuoteListComputedUpfrontLineItemsParams params)
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items.LineItemCollection
listComputedUpfrontLineItems(QuoteListComputedUpfrontLineItemsParams params, RequestOptions options)
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items.LineItemCollection
listComputedUpfrontLineItems(java.util.Map<java.lang.String,java.lang.Object> params)
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items.LineItemCollection
listComputedUpfrontLineItems(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items.LineItemCollection
listLineItems()
When retrieving a quote, there is an includable line_items property containing the first handful of those items.LineItemCollection
listLineItems(QuoteListLineItemsParams params)
When retrieving a quote, there is an includable line_items property containing the first handful of those items.LineItemCollection
listLineItems(QuoteListLineItemsParams params, RequestOptions options)
When retrieving a quote, there is an includable line_items property containing the first handful of those items.LineItemCollection
listLineItems(java.util.Map<java.lang.String,java.lang.Object> params)
When retrieving a quote, there is an includable line_items property containing the first handful of those items.LineItemCollection
listLineItems(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
When retrieving a quote, there is an includable line_items property containing the first handful of those items.java.io.InputStream
pdf()
Download the PDF for a finalized quote.java.io.InputStream
pdf(QuotePdfParams params)
Download the PDF for a finalized quote.java.io.InputStream
pdf(QuotePdfParams params, RequestOptions options)
Download the PDF for a finalized quote.java.io.InputStream
pdf(java.util.Map<java.lang.String,java.lang.Object> params)
Download the PDF for a finalized quote.java.io.InputStream
pdf(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Download the PDF for a finalized quote.static Quote
retrieve(java.lang.String quote)
Retrieves the quote with the given ID.static Quote
retrieve(java.lang.String quote, RequestOptions options)
Retrieves the quote with the given ID.static Quote
retrieve(java.lang.String quote, QuoteRetrieveParams params, RequestOptions options)
Retrieves the quote with the given ID.static Quote
retrieve(java.lang.String quote, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves the quote with the given ID.void
setAmountSubtotal(java.lang.Long amountSubtotal)
Total before any discounts or taxes are applied.void
setAmountTotal(java.lang.Long amountTotal)
Total after discounts and taxes are applied.void
setApplicationFeeAmount(java.lang.Long applicationFeeAmount)
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.void
setApplicationFeePercent(java.math.BigDecimal applicationFeePercent)
A non-negative decimal between 0 and 100, with at most two decimal places.void
setAutomaticTax(Quote.AutomaticTax automaticTax)
void
setCollectionMethod(java.lang.String collectionMethod)
Eithercharge_automatically
, orsend_invoice
.void
setComputed(Quote.Computed computed)
void
setCreated(java.lang.Long created)
Time at which the object was created.void
setCurrency(java.lang.String currency)
Three-letter ISO currency code, in lowercase.void
setCustomer(java.lang.String id)
void
setCustomerObject(Customer expandableObject)
void
setDefaultTaxRateObjects(java.util.List<TaxRate> objs)
void
setDefaultTaxRates(java.util.List<java.lang.String> ids)
void
setDescription(java.lang.String description)
A description that will be displayed on the quote PDF.void
setDiscountObjects(java.util.List<Discount> objs)
void
setDiscounts(java.util.List<java.lang.String> ids)
void
setExpiresAt(java.lang.Long expiresAt)
The date on which the quote will be canceled if inopen
ordraft
status.void
setFooter(java.lang.String footer)
A footer that will be displayed on the quote PDF.void
setFromQuote(Quote.FromQuote fromQuote)
Details of the quote that was cloned.void
setHeader(java.lang.String header)
A header that will be displayed on the quote PDF.void
setId(java.lang.String id)
Unique identifier for the object.void
setInvoice(java.lang.String id)
void
setInvoiceObject(Invoice expandableObject)
void
setInvoiceSettings(Quote.InvoiceSettings invoiceSettings)
All invoices will be billed using the specified settings.void
setLineItems(LineItemCollection lineItems)
A list of items the customer is being quoted for.void
setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.void
setNumber(java.lang.String number)
A unique number that identifies this particular quote.void
setObject(java.lang.String object)
String representing the object's type.void
setOnBehalfOf(java.lang.String id)
void
setOnBehalfOfObject(Account expandableObject)
void
setStatus(java.lang.String status)
The status of the quote.void
setStatusTransitions(Quote.StatusTransitions statusTransitions)
void
setSubscription(java.lang.String id)
void
setSubscriptionData(Quote.SubscriptionData subscriptionData)
void
setSubscriptionObject(Subscription expandableObject)
void
setSubscriptionSchedule(java.lang.String id)
void
setSubscriptionScheduleObject(SubscriptionSchedule expandableObject)
void
setTotalDetails(Quote.TotalDetails totalDetails)
void
setTransferData(Quote.TransferData transferData)
The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.Quote
update(QuoteUpdateParams params)
A quote models prices and services for a customer.Quote
update(QuoteUpdateParams params, RequestOptions options)
A quote models prices and services for a customer.Quote
update(java.util.Map<java.lang.String,java.lang.Object> params)
A quote models prices and services for a customer.Quote
update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
A quote models prices and services for a customer.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
-
-
-
Method Detail
-
getCustomer
public java.lang.String getCustomer()
Get ID of expandablecustomer
object.
-
setCustomer
public void setCustomer(java.lang.String id)
-
getCustomerObject
public Customer getCustomerObject()
Get expandedcustomer
.
-
setCustomerObject
public void setCustomerObject(Customer expandableObject)
-
getInvoice
public java.lang.String getInvoice()
Get ID of expandableinvoice
object.
-
setInvoice
public void setInvoice(java.lang.String id)
-
getInvoiceObject
public Invoice getInvoiceObject()
Get expandedinvoice
.
-
setInvoiceObject
public void setInvoiceObject(Invoice expandableObject)
-
getOnBehalfOf
public java.lang.String getOnBehalfOf()
Get ID of expandableonBehalfOf
object.
-
setOnBehalfOf
public void setOnBehalfOf(java.lang.String id)
-
getOnBehalfOfObject
public Account getOnBehalfOfObject()
Get expandedonBehalfOf
.
-
setOnBehalfOfObject
public void setOnBehalfOfObject(Account expandableObject)
-
getSubscription
public java.lang.String getSubscription()
Get ID of expandablesubscription
object.
-
setSubscription
public void setSubscription(java.lang.String id)
-
getSubscriptionObject
public Subscription getSubscriptionObject()
Get expandedsubscription
.
-
setSubscriptionObject
public void setSubscriptionObject(Subscription expandableObject)
-
getSubscriptionSchedule
public java.lang.String getSubscriptionSchedule()
Get ID of expandablesubscriptionSchedule
object.
-
setSubscriptionSchedule
public void setSubscriptionSchedule(java.lang.String id)
-
getSubscriptionScheduleObject
public SubscriptionSchedule getSubscriptionScheduleObject()
Get expandedsubscriptionSchedule
.
-
setSubscriptionScheduleObject
public void setSubscriptionScheduleObject(SubscriptionSchedule expandableObject)
-
getDefaultTaxRates
public java.util.List<java.lang.String> getDefaultTaxRates()
Get IDs of expandabledefaultTaxRates
object list.
-
setDefaultTaxRates
public void setDefaultTaxRates(java.util.List<java.lang.String> ids)
-
getDefaultTaxRateObjects
public java.util.List<TaxRate> getDefaultTaxRateObjects()
Get expandeddefaultTaxRates
.
-
setDefaultTaxRateObjects
public void setDefaultTaxRateObjects(java.util.List<TaxRate> objs)
-
getDiscounts
public java.util.List<java.lang.String> getDiscounts()
Get IDs of expandablediscounts
object list.
-
setDiscounts
public void setDiscounts(java.util.List<java.lang.String> ids)
-
getDiscountObjects
public java.util.List<Discount> getDiscountObjects()
Get expandeddiscounts
.
-
setDiscountObjects
public void setDiscountObjects(java.util.List<Discount> objs)
-
retrieve
public static Quote retrieve(java.lang.String quote) throws StripeException
Retrieves the quote with the given ID.- Throws:
StripeException
-
retrieve
public static Quote retrieve(java.lang.String quote, RequestOptions options) throws StripeException
Retrieves the quote with the given ID.- Throws:
StripeException
-
retrieve
public static Quote retrieve(java.lang.String quote, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves the quote with the given ID.- Throws:
StripeException
-
retrieve
public static Quote retrieve(java.lang.String quote, QuoteRetrieveParams params, RequestOptions options) throws StripeException
Retrieves the quote with the given ID.- Throws:
StripeException
-
create
public static Quote create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
A quote models prices and services for a customer. Default options forheader
,description
,footer
, andexpires_at
can be set in the dashboard via the quote template.- Throws:
StripeException
-
create
public static Quote create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
A quote models prices and services for a customer. Default options forheader
,description
,footer
, andexpires_at
can be set in the dashboard via the quote template.- Throws:
StripeException
-
create
public static Quote create(QuoteCreateParams params) throws StripeException
A quote models prices and services for a customer. Default options forheader
,description
,footer
, andexpires_at
can be set in the dashboard via the quote template.- Throws:
StripeException
-
create
public static Quote create(QuoteCreateParams params, RequestOptions options) throws StripeException
A quote models prices and services for a customer. Default options forheader
,description
,footer
, andexpires_at
can be set in the dashboard via the quote template.- Throws:
StripeException
-
update
public Quote update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
A quote models prices and services for a customer.- Specified by:
update
in interfaceMetadataStore<Quote>
- Throws:
StripeException
-
update
public Quote update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
A quote models prices and services for a customer.- Specified by:
update
in interfaceMetadataStore<Quote>
- Throws:
StripeException
-
update
public Quote update(QuoteUpdateParams params) throws StripeException
A quote models prices and services for a customer.- Throws:
StripeException
-
update
public Quote update(QuoteUpdateParams params, RequestOptions options) throws StripeException
A quote models prices and services for a customer.- Throws:
StripeException
-
cancel
public Quote cancel() throws StripeException
Cancels the quote.- Throws:
StripeException
-
cancel
public Quote cancel(RequestOptions options) throws StripeException
Cancels the quote.- Throws:
StripeException
-
cancel
public Quote cancel(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Cancels the quote.- Throws:
StripeException
-
cancel
public Quote cancel(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Cancels the quote.- Throws:
StripeException
-
cancel
public Quote cancel(QuoteCancelParams params) throws StripeException
Cancels the quote.- Throws:
StripeException
-
cancel
public Quote cancel(QuoteCancelParams params, RequestOptions options) throws StripeException
Cancels the quote.- Throws:
StripeException
-
finalizeQuote
public Quote finalizeQuote() throws StripeException
Finalizes the quote.- Throws:
StripeException
-
finalizeQuote
public Quote finalizeQuote(RequestOptions options) throws StripeException
Finalizes the quote.- Throws:
StripeException
-
finalizeQuote
public Quote finalizeQuote(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Finalizes the quote.- Throws:
StripeException
-
finalizeQuote
public Quote finalizeQuote(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Finalizes the quote.- Throws:
StripeException
-
finalizeQuote
public Quote finalizeQuote(QuoteFinalizeQuoteParams params) throws StripeException
Finalizes the quote.- Throws:
StripeException
-
finalizeQuote
public Quote finalizeQuote(QuoteFinalizeQuoteParams params, RequestOptions options) throws StripeException
Finalizes the quote.- Throws:
StripeException
-
accept
public Quote accept() throws StripeException
Accepts the specified quote.- Throws:
StripeException
-
accept
public Quote accept(RequestOptions options) throws StripeException
Accepts the specified quote.- Throws:
StripeException
-
accept
public Quote accept(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Accepts the specified quote.- Throws:
StripeException
-
accept
public Quote accept(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Accepts the specified quote.- Throws:
StripeException
-
accept
public Quote accept(QuoteAcceptParams params) throws StripeException
Accepts the specified quote.- Throws:
StripeException
-
accept
public Quote accept(QuoteAcceptParams params, RequestOptions options) throws StripeException
Accepts the specified quote.- Throws:
StripeException
-
list
public static QuoteCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of your quotes.- Throws:
StripeException
-
list
public static QuoteCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list of your quotes.- Throws:
StripeException
-
list
public static QuoteCollection list(QuoteListParams params) throws StripeException
Returns a list of your quotes.- Throws:
StripeException
-
list
public static QuoteCollection list(QuoteListParams params, RequestOptions options) throws StripeException
Returns a list of your quotes.- Throws:
StripeException
-
listLineItems
public LineItemCollection listLineItems() throws StripeException
When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.- Throws:
StripeException
-
listLineItems
public LineItemCollection listLineItems(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.- Throws:
StripeException
-
listLineItems
public LineItemCollection listLineItems(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.- Throws:
StripeException
-
listLineItems
public LineItemCollection listLineItems(QuoteListLineItemsParams params) throws StripeException
When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.- Throws:
StripeException
-
listLineItems
public LineItemCollection listLineItems(QuoteListLineItemsParams params, RequestOptions options) throws StripeException
When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.- Throws:
StripeException
-
listComputedUpfrontLineItems
public LineItemCollection listComputedUpfrontLineItems() throws StripeException
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.- Throws:
StripeException
-
listComputedUpfrontLineItems
public LineItemCollection listComputedUpfrontLineItems(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.- Throws:
StripeException
-
listComputedUpfrontLineItems
public LineItemCollection listComputedUpfrontLineItems(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.- Throws:
StripeException
-
listComputedUpfrontLineItems
public LineItemCollection listComputedUpfrontLineItems(QuoteListComputedUpfrontLineItemsParams params) throws StripeException
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.- Throws:
StripeException
-
listComputedUpfrontLineItems
public LineItemCollection listComputedUpfrontLineItems(QuoteListComputedUpfrontLineItemsParams params, RequestOptions options) throws StripeException
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.- Throws:
StripeException
-
pdf
public java.io.InputStream pdf() throws StripeException
Download the PDF for a finalized quote.- Throws:
StripeException
-
pdf
public java.io.InputStream pdf(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Download the PDF for a finalized quote.- Throws:
StripeException
-
pdf
public java.io.InputStream pdf(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Download the PDF for a finalized quote.- Throws:
StripeException
-
pdf
public java.io.InputStream pdf(QuotePdfParams params) throws StripeException
Download the PDF for a finalized quote.- Throws:
StripeException
-
pdf
public java.io.InputStream pdf(QuotePdfParams params, RequestOptions options) throws StripeException
Download the PDF for a finalized quote.- Throws:
StripeException
-
getAmountSubtotal
public java.lang.Long getAmountSubtotal()
Total before any discounts or taxes are applied.
-
getAmountTotal
public java.lang.Long getAmountTotal()
Total after discounts and taxes are applied.
-
getApplicationFeeAmount
public java.lang.Long getApplicationFeeAmount()
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.
-
getApplicationFeePercent
public java.math.BigDecimal getApplicationFeePercent()
A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.
-
getAutomaticTax
public Quote.AutomaticTax getAutomaticTax()
-
getCollectionMethod
public java.lang.String getCollectionMethod()
Eithercharge_automatically
, orsend_invoice
. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults tocharge_automatically
.One of
charge_automatically
, orsend_invoice
.
-
getComputed
public Quote.Computed getComputed()
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
getDescription
public java.lang.String getDescription()
A description that will be displayed on the quote PDF.
-
getExpiresAt
public java.lang.Long getExpiresAt()
The date on which the quote will be canceled if inopen
ordraft
status. Measured in seconds since the Unix epoch.
-
getFooter
public java.lang.String getFooter()
A footer that will be displayed on the quote PDF.
-
getFromQuote
public Quote.FromQuote getFromQuote()
Details of the quote that was cloned. See the cloning documentation for more details.
-
getHeader
public java.lang.String getHeader()
A header that will be displayed on the quote PDF.
-
getInvoiceSettings
public Quote.InvoiceSettings getInvoiceSettings()
All invoices will be billed using the specified settings.
-
getLineItems
public LineItemCollection getLineItems()
A list of items the customer is being quoted for.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getNumber
public java.lang.String getNumber()
A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
quote
.
-
getStatus
public java.lang.String getStatus()
The status of the quote.One of
accepted
,canceled
,draft
, oropen
.
-
getStatusTransitions
public Quote.StatusTransitions getStatusTransitions()
-
getSubscriptionData
public Quote.SubscriptionData getSubscriptionData()
-
getTotalDetails
public Quote.TotalDetails getTotalDetails()
-
getTransferData
public Quote.TransferData getTransferData()
The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.
-
setAmountSubtotal
public void setAmountSubtotal(java.lang.Long amountSubtotal)
Total before any discounts or taxes are applied.
-
setAmountTotal
public void setAmountTotal(java.lang.Long amountTotal)
Total after discounts and taxes are applied.
-
setApplicationFeeAmount
public void setApplicationFeeAmount(java.lang.Long applicationFeeAmount)
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.
-
setApplicationFeePercent
public void setApplicationFeePercent(java.math.BigDecimal applicationFeePercent)
A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.
-
setAutomaticTax
public void setAutomaticTax(Quote.AutomaticTax automaticTax)
-
setCollectionMethod
public void setCollectionMethod(java.lang.String collectionMethod)
Eithercharge_automatically
, orsend_invoice
. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults tocharge_automatically
.One of
charge_automatically
, orsend_invoice
.
-
setComputed
public void setComputed(Quote.Computed computed)
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setCurrency
public void setCurrency(java.lang.String currency)
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
setDescription
public void setDescription(java.lang.String description)
A description that will be displayed on the quote PDF.
-
setExpiresAt
public void setExpiresAt(java.lang.Long expiresAt)
The date on which the quote will be canceled if inopen
ordraft
status. Measured in seconds since the Unix epoch.
-
setFooter
public void setFooter(java.lang.String footer)
A footer that will be displayed on the quote PDF.
-
setFromQuote
public void setFromQuote(Quote.FromQuote fromQuote)
Details of the quote that was cloned. See the cloning documentation for more details.
-
setHeader
public void setHeader(java.lang.String header)
A header that will be displayed on the quote PDF.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setInvoiceSettings
public void setInvoiceSettings(Quote.InvoiceSettings invoiceSettings)
All invoices will be billed using the specified settings.
-
setLineItems
public void setLineItems(LineItemCollection lineItems)
A list of items the customer is being quoted for.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
setMetadata
public void setMetadata(java.util.Map<java.lang.String,java.lang.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.
-
setNumber
public void setNumber(java.lang.String number)
A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
-
setObject
public void setObject(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
quote
.
-
setStatus
public void setStatus(java.lang.String status)
The status of the quote.One of
accepted
,canceled
,draft
, oropen
.
-
setStatusTransitions
public void setStatusTransitions(Quote.StatusTransitions statusTransitions)
-
setSubscriptionData
public void setSubscriptionData(Quote.SubscriptionData subscriptionData)
-
setTotalDetails
public void setTotalDetails(Quote.TotalDetails totalDetails)
-
setTransferData
public void setTransferData(Quote.TransferData transferData)
The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
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.- Specified by:
getMetadata
in interfaceMetadataStore<Quote>
-
-