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>, StripeActiveObject, StripeObjectInterface

public class Quote
extends ApiResource
implements HasId, MetadataStore<Quote>

A Quote is a way to model prices that you'd like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Quote.AutomaticTax	For more details about AutomaticTax, please refer to the API Reference.
static class	Quote.Computed	For more details about Computed, please refer to the API Reference.
static class	Quote.FromQuote	For more details about FromQuote, please refer to the API Reference.
static class	Quote.InvoiceSettings	For more details about InvoiceSettings, please refer to the API Reference.
static class	Quote.StatusDetails	For more details about StatusDetails, please refer to the API Reference.
static class	Quote.StatusTransitions	For more details about StatusTransitions, please refer to the API Reference.
static class	Quote.SubscriptionData	For more details about SubscriptionData, please refer to the API Reference.
static class	Quote.SubscriptionDataOverride	For more details about SubscriptionDataOverride, please refer to the API Reference.
static class	Quote.SubscriptionSchedule	For more details about SubscriptionSchedule, please refer to the API Reference.
static class	Quote.TotalDetails	For more details about TotalDetails, please refer to the API Reference.
static class	Quote.TransferData	For more details about TransferData, please refer to the API Reference.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Quote()

Method Summary

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(Map<String,Object> params)	Accepts the specified quote.
Quote	accept(Map<String,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(Map<String,Object> params)	Cancels the quote.
Quote	cancel(Map<String,Object> params, RequestOptions options)	Cancels the quote.
protected boolean	canEqual(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(Map<String,Object> params)	A quote models prices and services for a customer.
static Quote	create(Map<String,Object> params, RequestOptions options)	A quote models prices and services for a customer.
boolean	equals(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(Map<String,Object> params)	Finalizes the quote.
Quote	finalizeQuote(Map<String,Object> params, RequestOptions options)	Finalizes the quote.
Boolean	getAllowBackdatedLines()	Allow quote lines to have starts_at in the past if collection is paused between starts_at and now.
Long	getAmountSubtotal()	Total before any discounts or taxes are applied.
Long	getAmountTotal()	Total after discounts and taxes are applied.
String	getApplication()	Get ID of expandable application object.
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.
BigDecimal	getApplicationFeePercent()	A non-negative decimal between 0 and 100, with at most two decimal places.
Application	getApplicationObject()	Get expanded application.
Quote.AutomaticTax	getAutomaticTax()
String	getCollectionMethod()	Either charge_automatically, or send_invoice.
Quote.Computed	getComputed()
Long	getCreated()	Time at which the object was created.
String	getCurrency()	Three-letter ISO currency code, in lowercase.
String	getCustomer()	Get ID of expandable customer object.
String	getCustomerAccount()	The account which this quote belongs to.
Customer	getCustomerObject()	Get expanded customer.
List<TaxRate>	getDefaultTaxRateObjects()	Get expanded defaultTaxRates.
List<String>	getDefaultTaxRates()	Get IDs of expandable defaultTaxRates object list.
String	getDescription()	A description that will be displayed on the quote PDF.
List<Discount>	getDiscountObjects()	Get expanded discounts.
List<String>	getDiscounts()	Get IDs of expandable discounts object list.
Long	getExpiresAt()	The date on which the quote will be canceled if in open or draft status.
String	getFooter()	A footer that will be displayed on the quote PDF.
Quote.FromQuote	getFromQuote()	Details of the quote that was cloned.
String	getHeader()	A header that will be displayed on the quote PDF.
String	getId()	Unique identifier for the object.
String	getInvoice()	Get ID of expandable invoice object.
Invoice	getInvoiceObject()	Get expanded invoice.
Quote.InvoiceSettings	getInvoiceSettings()
LineItemCollection	getLineItems()	A list of items the customer is being quoted for.
List<String>	getLines()	A list of quote lines on the quote.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getNumber()	A unique number that identifies this particular quote.
String	getObject()	String representing the object's type.
String	getOnBehalfOf()	Get ID of expandable onBehalfOf object.
Account	getOnBehalfOfObject()	Get expanded onBehalfOf.
String	getStatus()	The status of the quote.
Quote.StatusDetails	getStatusDetails()	Details on when and why a quote has been marked as stale or canceled.
Quote.StatusTransitions	getStatusTransitions()
String	getSubscription()	Get ID of expandable subscription object.
Quote.SubscriptionData	getSubscriptionData()
List<Quote.SubscriptionDataOverride>	getSubscriptionDataOverrides()	List representing overrides for subscription_data configurations for specific subscription schedules.
Subscription	getSubscriptionObject()	Get expanded subscription.
String	getSubscriptionSchedule()	Get ID of expandable subscriptionSchedule object.
SubscriptionSchedule	getSubscriptionScheduleObject()	Get expanded subscriptionSchedule.
List<Quote.SubscriptionSchedule>	getSubscriptionSchedules()	The subscription schedules that were created or updated from this quote.
String	getTestClock()	Get ID of expandable testClock object.
TestClock	getTestClockObject()	Get expanded testClock.
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(Map<String,Object> params)	Returns a list of your quotes.
static QuoteCollection	list(Map<String,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(Map<String,Object> params)	When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items.
LineItemCollection	listComputedUpfrontLineItems(Map<String,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(Map<String,Object> params)	When retrieving a quote, there is an includable line_items property containing the first handful of those items.
LineItemCollection	listLineItems(Map<String,Object> params, RequestOptions options)	When retrieving a quote, there is an includable line_items property containing the first handful of those items.
QuoteLineCollection	listLines()	Retrieves a paginated list of lines for a quote.
QuoteLineCollection	listLines(QuoteListLinesParams params)	Retrieves a paginated list of lines for a quote.
QuoteLineCollection	listLines(QuoteListLinesParams params, RequestOptions options)	Retrieves a paginated list of lines for a quote.
QuoteLineCollection	listLines(Map<String,Object> params)	Retrieves a paginated list of lines for a quote.
QuoteLineCollection	listLines(Map<String,Object> params, RequestOptions options)	Retrieves a paginated list of lines for a quote.
InvoiceLineItemCollection	listPreviewInvoiceLines(String previewInvoice)	Preview the invoice line items that would be generated by accepting the quote.
InvoiceLineItemCollection	listPreviewInvoiceLines(String previewInvoice, RequestOptions options)	Preview the invoice line items that would be generated by accepting the quote.
InvoiceLineItemCollection	listPreviewInvoiceLines(String previewInvoice, QuoteListPreviewInvoiceLinesParams params)	Preview the invoice line items that would be generated by accepting the quote.
InvoiceLineItemCollection	listPreviewInvoiceLines(String previewInvoice, QuoteListPreviewInvoiceLinesParams params, RequestOptions options)	Preview the invoice line items that would be generated by accepting the quote.
InvoiceLineItemCollection	listPreviewInvoiceLines(String previewInvoice, Map<String,Object> params)	Preview the invoice line items that would be generated by accepting the quote.
InvoiceLineItemCollection	listPreviewInvoiceLines(String previewInvoice, Map<String,Object> params, RequestOptions options)	Preview the invoice line items that would be generated by accepting the quote.
Quote	markDraft()	Converts a stale quote to draft.
Quote	markDraft(RequestOptions options)	Converts a stale quote to draft.
Quote	markDraft(QuoteMarkDraftParams params)	Converts a stale quote to draft.
Quote	markDraft(QuoteMarkDraftParams params, RequestOptions options)	Converts a stale quote to draft.
Quote	markDraft(Map<String,Object> params)	Converts a stale quote to draft.
Quote	markDraft(Map<String,Object> params, RequestOptions options)	Converts a stale quote to draft.
Quote	markStale()	Converts a draft or open quote to stale.
Quote	markStale(RequestOptions options)	Converts a draft or open quote to stale.
Quote	markStale(QuoteMarkStaleParams params)	Converts a draft or open quote to stale.
Quote	markStale(QuoteMarkStaleParams params, RequestOptions options)	Converts a draft or open quote to stale.
Quote	markStale(Map<String,Object> params)	Converts a draft or open quote to stale.
Quote	markStale(Map<String,Object> params, RequestOptions options)	Converts a draft or open quote to stale.
InputStream	pdf()	Download the PDF for a finalized quote.
InputStream	pdf(QuotePdfParams params)	Download the PDF for a finalized quote.
InputStream	pdf(QuotePdfParams params, RequestOptions options)	Download the PDF for a finalized quote.
InputStream	pdf(Map<String,Object> params)	Download the PDF for a finalized quote.
InputStream	pdf(Map<String,Object> params, RequestOptions options)	Download the PDF for a finalized quote.
Quote	reestimate()	Recompute the upcoming invoice estimate for the quote.
Quote	reestimate(RequestOptions options)	Recompute the upcoming invoice estimate for the quote.
Quote	reestimate(QuoteReestimateParams params)	Recompute the upcoming invoice estimate for the quote.
Quote	reestimate(QuoteReestimateParams params, RequestOptions options)	Recompute the upcoming invoice estimate for the quote.
Quote	reestimate(Map<String,Object> params)	Recompute the upcoming invoice estimate for the quote.
Quote	reestimate(Map<String,Object> params, RequestOptions options)	Recompute the upcoming invoice estimate for the quote.
static Quote	retrieve(String quote)	Retrieves the quote with the given ID.
static Quote	retrieve(String quote, RequestOptions options)	Retrieves the quote with the given ID.
static Quote	retrieve(String quote, QuoteRetrieveParams params, RequestOptions options)	Retrieves the quote with the given ID.
static Quote	retrieve(String quote, Map<String,Object> params, RequestOptions options)	Retrieves the quote with the given ID.
void	setAllowBackdatedLines(Boolean allowBackdatedLines)	Allow quote lines to have starts_at in the past if collection is paused between starts_at and now.
void	setAmountSubtotal(Long amountSubtotal)	Total before any discounts or taxes are applied.
void	setAmountTotal(Long amountTotal)	Total after discounts and taxes are applied.
void	setApplication(String id)
void	setApplicationFeeAmount(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(BigDecimal applicationFeePercent)	A non-negative decimal between 0 and 100, with at most two decimal places.
void	setApplicationObject(Application expandableObject)
void	setAutomaticTax(Quote.AutomaticTax automaticTax)
void	setCollectionMethod(String collectionMethod)	Either charge_automatically, or send_invoice.
void	setComputed(Quote.Computed computed)
void	setCreated(Long created)	Time at which the object was created.
void	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
void	setCustomer(String id)
void	setCustomerAccount(String customerAccount)	The account which this quote belongs to.
void	setCustomerObject(Customer expandableObject)
void	setDefaultTaxRateObjects(List<TaxRate> objs)
void	setDefaultTaxRates(List<String> ids)
void	setDescription(String description)	A description that will be displayed on the quote PDF.
void	setDiscountObjects(List<Discount> objs)
void	setDiscounts(List<String> ids)
void	setExpiresAt(Long expiresAt)	The date on which the quote will be canceled if in open or draft status.
void	setFooter(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(String header)	A header that will be displayed on the quote PDF.
void	setId(String id)	Unique identifier for the object.
void	setInvoice(String id)
void	setInvoiceObject(Invoice expandableObject)
void	setInvoiceSettings(Quote.InvoiceSettings invoiceSettings)
void	setLineItems(LineItemCollection lineItems)	A list of items the customer is being quoted for.
void	setLines(List<String> lines)	A list of quote lines on the quote.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setNumber(String number)	A unique number that identifies this particular quote.
void	setObject(String object)	String representing the object's type.
void	setOnBehalfOf(String id)
void	setOnBehalfOfObject(Account expandableObject)
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setStatus(String status)	The status of the quote.
void	setStatusDetails(Quote.StatusDetails statusDetails)	Details on when and why a quote has been marked as stale or canceled.
void	setStatusTransitions(Quote.StatusTransitions statusTransitions)
void	setSubscription(String id)
void	setSubscriptionData(Quote.SubscriptionData subscriptionData)
void	setSubscriptionDataOverrides(List<Quote.SubscriptionDataOverride> subscriptionDataOverrides)	List representing overrides for subscription_data configurations for specific subscription schedules.
void	setSubscriptionObject(Subscription expandableObject)
void	setSubscriptionSchedule(String id)
void	setSubscriptionScheduleObject(SubscriptionSchedule expandableObject)
void	setSubscriptionSchedules(List<Quote.SubscriptionSchedule> subscriptionSchedules)	The subscription schedules that were created or updated from this quote.
void	setTestClock(String id)
void	setTestClockObject(TestClock 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(Map<String,Object> params)	A quote models prices and services for a customer.
Quote	update(Map<String,Object> params, RequestOptions options)	A quote models prices and services for a customer.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

Quote

public Quote()

Method Details

getApplication

public String getApplication()

Get ID of expandable application object.

setApplication

public void setApplication(String id)

getApplicationObject

public Application getApplicationObject()

Get expanded application.

setApplicationObject

public void setApplicationObject(Application expandableObject)

getCustomer

public String getCustomer()

Get ID of expandable customer object.

setCustomer

public void setCustomer(String id)

getCustomerObject

public Customer getCustomerObject()

Get expanded customer.

setCustomerObject

public void setCustomerObject(Customer expandableObject)

getInvoice

public String getInvoice()

Get ID of expandable invoice object.

setInvoice

public void setInvoice(String id)

getInvoiceObject

public Invoice getInvoiceObject()

Get expanded invoice.

setInvoiceObject

public void setInvoiceObject(Invoice expandableObject)

getOnBehalfOf

public String getOnBehalfOf()

Get ID of expandable onBehalfOf object.

setOnBehalfOf

public void setOnBehalfOf(String id)

getOnBehalfOfObject

public Account getOnBehalfOfObject()

Get expanded onBehalfOf.

setOnBehalfOfObject

public void setOnBehalfOfObject(Account expandableObject)

getSubscription

public String getSubscription()

Get ID of expandable subscription object.

setSubscription

public void setSubscription(String id)

getSubscriptionObject

public Subscription getSubscriptionObject()

Get expanded subscription.

setSubscriptionObject

public void setSubscriptionObject(Subscription expandableObject)

getSubscriptionSchedule

public String getSubscriptionSchedule()

Get ID of expandable subscriptionSchedule object.

setSubscriptionSchedule

public void setSubscriptionSchedule(String id)

getSubscriptionScheduleObject

public SubscriptionSchedule getSubscriptionScheduleObject()

Get expanded subscriptionSchedule.

setSubscriptionScheduleObject

public void setSubscriptionScheduleObject(SubscriptionSchedule expandableObject)

getTestClock

public String getTestClock()

Get ID of expandable testClock object.

setTestClock

public void setTestClock(String id)

getTestClockObject

public TestClock getTestClockObject()

Get expanded testClock.

setTestClockObject

public void setTestClockObject(TestClock expandableObject)

getDefaultTaxRates

public List<String> getDefaultTaxRates()

Get IDs of expandable defaultTaxRates object list.

setDefaultTaxRates

public void setDefaultTaxRates(List<String> ids)

getDefaultTaxRateObjects

public List<TaxRate> getDefaultTaxRateObjects()

Get expanded defaultTaxRates.

setDefaultTaxRateObjects

public void setDefaultTaxRateObjects(List<TaxRate> objs)

getDiscounts

public List<String> getDiscounts()

Get IDs of expandable discounts object list.

setDiscounts

public void setDiscounts(List<String> ids)

getDiscountObjects

public List<Discount> getDiscountObjects()

Get expanded discounts.

setDiscountObjects

public void setDiscountObjects(List<Discount> objs)

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(Map<String,Object> params)
             throws StripeException

Accepts the specified quote.

Throws:

StripeException

accept

public Quote accept(Map<String,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

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(Map<String,Object> params)
             throws StripeException

Cancels the quote.

Throws:

StripeException

cancel

public Quote cancel(Map<String,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

create

public static Quote create(Map<String,Object> params)
                    throws StripeException

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

Throws:

StripeException

create

public static Quote create(Map<String,Object> params,
 RequestOptions options)
                    throws StripeException

A quote models prices and services for a customer. Default options for header, description, footer, and expires_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 for header, description, footer, and expires_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 for header, description, footer, and expires_at can be set in the dashboard via the quote template.

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(Map<String,Object> params)
                    throws StripeException

Finalizes the quote.

Throws:

StripeException

finalizeQuote

public Quote finalizeQuote(Map<String,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

list

public static QuoteCollection list(Map<String,Object> params)
                            throws StripeException

Returns a list of your quotes.

Throws:

StripeException

list

public static QuoteCollection list(Map<String,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

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(Map<String,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(Map<String,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

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(Map<String,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(Map<String,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

listLines

public QuoteLineCollection listLines()
                              throws StripeException

Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.

Throws:

StripeException

listLines

public QuoteLineCollection listLines(Map<String,Object> params)
                              throws StripeException

Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.

Throws:

StripeException

listLines

public QuoteLineCollection listLines(Map<String,Object> params,
 RequestOptions options)
                              throws StripeException

Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.

Throws:

StripeException

listLines

public QuoteLineCollection listLines(QuoteListLinesParams params)
                              throws StripeException

Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.

Throws:

StripeException

listLines

public QuoteLineCollection listLines(QuoteListLinesParams params,
 RequestOptions options)
                              throws StripeException

Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.

Throws:

StripeException

listPreviewInvoiceLines

public InvoiceLineItemCollection listPreviewInvoiceLines(String previewInvoice)
                                                  throws StripeException

Preview the invoice line items that would be generated by accepting the quote.

Throws:

StripeException

listPreviewInvoiceLines

public InvoiceLineItemCollection listPreviewInvoiceLines(String previewInvoice,
 RequestOptions options)
                                                  throws StripeException

Preview the invoice line items that would be generated by accepting the quote.

Throws:

StripeException

listPreviewInvoiceLines

public InvoiceLineItemCollection listPreviewInvoiceLines(String previewInvoice,
 Map<String,Object> params)
                                                  throws StripeException

Preview the invoice line items that would be generated by accepting the quote.

Throws:

StripeException

listPreviewInvoiceLines

public InvoiceLineItemCollection listPreviewInvoiceLines(String previewInvoice,
 Map<String,Object> params,
 RequestOptions options)
                                                  throws StripeException

Preview the invoice line items that would be generated by accepting the quote.

Throws:

StripeException

listPreviewInvoiceLines

public InvoiceLineItemCollection listPreviewInvoiceLines(String previewInvoice,
 QuoteListPreviewInvoiceLinesParams params)
                                                  throws StripeException

Preview the invoice line items that would be generated by accepting the quote.

Throws:

StripeException

listPreviewInvoiceLines

public InvoiceLineItemCollection listPreviewInvoiceLines(String previewInvoice,
 QuoteListPreviewInvoiceLinesParams params,
 RequestOptions options)
                                                  throws StripeException

Preview the invoice line items that would be generated by accepting the quote.

Throws:

StripeException

markDraft

public Quote markDraft()
                throws StripeException

Converts a stale quote to draft.

Throws:

StripeException

markDraft

public Quote markDraft(RequestOptions options)
                throws StripeException

Converts a stale quote to draft.

Throws:

StripeException

markDraft

public Quote markDraft(Map<String,Object> params)
                throws StripeException

Converts a stale quote to draft.

Throws:

StripeException

markDraft

public Quote markDraft(Map<String,Object> params,
 RequestOptions options)
                throws StripeException

Converts a stale quote to draft.

Throws:

StripeException

markDraft

public Quote markDraft(QuoteMarkDraftParams params)
                throws StripeException

Converts a stale quote to draft.

Throws:

StripeException

markDraft

public Quote markDraft(QuoteMarkDraftParams params,
 RequestOptions options)
                throws StripeException

Converts a stale quote to draft.

Throws:

StripeException

markStale

public Quote markStale()
                throws StripeException

Converts a draft or open quote to stale.

Throws:

StripeException

markStale

public Quote markStale(RequestOptions options)
                throws StripeException

Converts a draft or open quote to stale.

Throws:

StripeException

markStale

public Quote markStale(Map<String,Object> params)
                throws StripeException

Converts a draft or open quote to stale.

Throws:

StripeException

markStale

public Quote markStale(Map<String,Object> params,
 RequestOptions options)
                throws StripeException

Converts a draft or open quote to stale.

Throws:

StripeException

markStale

public Quote markStale(QuoteMarkStaleParams params)
                throws StripeException

Converts a draft or open quote to stale.

Throws:

StripeException

markStale

public Quote markStale(QuoteMarkStaleParams params,
 RequestOptions options)
                throws StripeException

Converts a draft or open quote to stale.

Throws:

StripeException

pdf

public InputStream pdf()
                throws StripeException

Download the PDF for a finalized quote. Explanation for special handling can be found here

Throws:

StripeException

pdf

public InputStream pdf(Map<String,Object> params)
                throws StripeException

Download the PDF for a finalized quote. Explanation for special handling can be found here

Throws:

StripeException

pdf

public InputStream pdf(Map<String,Object> params,
 RequestOptions options)
                throws StripeException

Download the PDF for a finalized quote. Explanation for special handling can be found here

Throws:

StripeException

pdf

public InputStream pdf(QuotePdfParams params)
                throws StripeException

Download the PDF for a finalized quote. Explanation for special handling can be found here

Throws:

StripeException

pdf

public InputStream pdf(QuotePdfParams params,
 RequestOptions options)
                throws StripeException

Download the PDF for a finalized quote. Explanation for special handling can be found here

Throws:

StripeException

reestimate

public Quote reestimate()
                 throws StripeException

Recompute the upcoming invoice estimate for the quote.

Throws:

StripeException

reestimate

public Quote reestimate(RequestOptions options)
                 throws StripeException

Recompute the upcoming invoice estimate for the quote.

Throws:

StripeException

reestimate

public Quote reestimate(Map<String,Object> params)
                 throws StripeException

Recompute the upcoming invoice estimate for the quote.

Throws:

StripeException

reestimate

public Quote reestimate(Map<String,Object> params,
 RequestOptions options)
                 throws StripeException

Recompute the upcoming invoice estimate for the quote.

Throws:

StripeException

reestimate

public Quote reestimate(QuoteReestimateParams params)
                 throws StripeException

Recompute the upcoming invoice estimate for the quote.

Throws:

StripeException

reestimate

public Quote reestimate(QuoteReestimateParams params,
 RequestOptions options)
                 throws StripeException

Recompute the upcoming invoice estimate for the quote.

Throws:

StripeException

retrieve

public static Quote retrieve(String quote)
                      throws StripeException

Retrieves the quote with the given ID.

Throws:

StripeException

retrieve

public static Quote retrieve(String quote,
 RequestOptions options)
                      throws StripeException

Retrieves the quote with the given ID.

Throws:

StripeException

retrieve

public static Quote retrieve(String quote,
 Map<String,Object> params,
 RequestOptions options)
                      throws StripeException

Retrieves the quote with the given ID.

Throws:

StripeException

retrieve

public static Quote retrieve(String quote,
 QuoteRetrieveParams params,
 RequestOptions options)
                      throws StripeException

Retrieves the quote with the given ID.

Throws:

StripeException

update

public Quote update(Map<String,Object> params)
             throws StripeException

A quote models prices and services for a customer.

Specified by:

update in interface MetadataStore<Quote>

Throws:

StripeException

update

public Quote update(Map<String,Object> params,
 RequestOptions options)
             throws StripeException

A quote models prices and services for a customer.

Specified by:

update in interface MetadataStore<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

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getAllowBackdatedLines

public Boolean getAllowBackdatedLines()

Allow quote lines to have starts_at in the past if collection is paused between starts_at and now.

getAmountSubtotal

public Long getAmountSubtotal()

Total before any discounts or taxes are applied.

getAmountTotal

public Long getAmountTotal()

Total after discounts and taxes are applied.

getApplicationFeeAmount

public 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 BigDecimal getApplicationFeePercent()

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total 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 String getCollectionMethod()

Either charge_automatically, or send_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 and mark the subscription as active. Defaults to charge_automatically.

One of charge_automatically, or send_invoice.

getComputed

public Quote.Computed getComputed()

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getCurrency

public String getCurrency()

Three-letter ISO currency code, in lowercase. Must be a supported currency.

getCustomerAccount

public String getCustomerAccount()

The account which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.

getDescription

public String getDescription()

A description that will be displayed on the quote PDF.

getExpiresAt

public Long getExpiresAt()

The date on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch.

getFooter

public 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 String getHeader()

A header that will be displayed on the quote PDF.

getInvoiceSettings

public Quote.InvoiceSettings getInvoiceSettings()

getLineItems

public LineItemCollection getLineItems()

A list of items the customer is being quoted for.

getLines

public List<String> getLines()

A list of quote lines on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getNumber

public String getNumber()

A unique number that identifies this particular quote. This number is assigned once the quote is finalized.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to quote.

getStatus

public String getStatus()

The status of the quote.

One of accepted, accepting, canceled, draft, open, or stale.

getStatusDetails

public Quote.StatusDetails getStatusDetails()

Details on when and why a quote has been marked as stale or canceled.

getStatusTransitions

public Quote.StatusTransitions getStatusTransitions()

getSubscriptionData

public Quote.SubscriptionData getSubscriptionData()

getSubscriptionDataOverrides

public List<Quote.SubscriptionDataOverride> getSubscriptionDataOverrides()

List representing overrides for subscription_data configurations for specific subscription schedules.

getSubscriptionSchedules

public List<Quote.SubscriptionSchedule> getSubscriptionSchedules()

The subscription schedules that were created or updated from this quote.

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.

setAllowBackdatedLines

public void setAllowBackdatedLines(Boolean allowBackdatedLines)

Allow quote lines to have starts_at in the past if collection is paused between starts_at and now.

setAmountSubtotal

public void setAmountSubtotal(Long amountSubtotal)

Total before any discounts or taxes are applied.

setAmountTotal

public void setAmountTotal(Long amountTotal)

Total after discounts and taxes are applied.

setApplicationFeeAmount

public void setApplicationFeeAmount(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(BigDecimal applicationFeePercent)

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total 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(String collectionMethod)

Either charge_automatically, or send_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 and mark the subscription as active. Defaults to charge_automatically.

One of charge_automatically, or send_invoice.

setComputed

public void setComputed(Quote.Computed computed)

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setCurrency

public void setCurrency(String currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

setCustomerAccount

public void setCustomerAccount(String customerAccount)

The account which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.

setDescription

public void setDescription(String description)

A description that will be displayed on the quote PDF.

setExpiresAt

public void setExpiresAt(Long expiresAt)

The date on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch.

setFooter

public void setFooter(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(String header)

A header that will be displayed on the quote PDF.

setId

public void setId(String id)

Unique identifier for the object.

setInvoiceSettings

public void setInvoiceSettings(Quote.InvoiceSettings invoiceSettings)

setLineItems

public void setLineItems(LineItemCollection lineItems)

A list of items the customer is being quoted for.

setLines

public void setLines(List<String> lines)

A list of quote lines on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setMetadata

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

setNumber

public void setNumber(String number)

A unique number that identifies this particular quote. This number is assigned once the quote is finalized.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to quote.

setStatus

public void setStatus(String status)

The status of the quote.

One of accepted, accepting, canceled, draft, open, or stale.

setStatusDetails

public void setStatusDetails(Quote.StatusDetails statusDetails)

Details on when and why a quote has been marked as stale or canceled.

setStatusTransitions

public void setStatusTransitions(Quote.StatusTransitions statusTransitions)

setSubscriptionData

public void setSubscriptionData(Quote.SubscriptionData subscriptionData)

setSubscriptionDataOverrides

public void setSubscriptionDataOverrides(List<Quote.SubscriptionDataOverride> subscriptionDataOverrides)

List representing overrides for subscription_data configurations for specific subscription schedules.

setSubscriptionSchedules

public void setSubscriptionSchedules(List<Quote.SubscriptionSchedule> subscriptionSchedules)

The subscription schedules that were created or updated from this quote.

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(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public Map<String,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 interface MetadataStore<Quote>