class Stripe::QuotesApi
- Stripe::QuotesApi
- Reference
- Object
Defined in:
stripe/api/quotes_api.crConstant Summary
-
GET_QUOTES_MAX_LENGTH_FOR_CUSTOMER =
5000
-
GET_QUOTES_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_QUOTES_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_QUOTES_MAX_LENGTH_FOR_TEST_CLOCK =
5000
-
GET_QUOTES_QUOTE_COMPUTED_UPFRONT_LINE_ITEMS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_QUOTES_QUOTE_COMPUTED_UPFRONT_LINE_ITEMS_MAX_LENGTH_FOR_QUOTE =
5000
-
GET_QUOTES_QUOTE_COMPUTED_UPFRONT_LINE_ITEMS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_QUOTES_QUOTE_LINE_ITEMS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_QUOTES_QUOTE_LINE_ITEMS_MAX_LENGTH_FOR_QUOTE =
5000
-
GET_QUOTES_QUOTE_LINE_ITEMS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_QUOTES_QUOTE_MAX_LENGTH_FOR_QUOTE =
5000
-
GET_QUOTES_QUOTE_PDF_MAX_LENGTH_FOR_QUOTE =
5000
-
GET_QUOTES_VALID_VALUES_FOR_STATUS =
String.static_array("accepted", "canceled", "draft", "open")
-
POST_QUOTES_MAX_LENGTH_FOR_CUSTOMER =
5000
-
POST_QUOTES_MAX_LENGTH_FOR_TEST_CLOCK =
5000
-
POST_QUOTES_QUOTE_ACCEPT_MAX_LENGTH_FOR_QUOTE =
5000
-
POST_QUOTES_QUOTE_CANCEL_MAX_LENGTH_FOR_QUOTE =
5000
-
POST_QUOTES_QUOTE_FINALIZE_MAX_LENGTH_FOR_QUOTE =
5000
-
POST_QUOTES_QUOTE_MAX_LENGTH_FOR_CUSTOMER =
5000
-
POST_QUOTES_QUOTE_MAX_LENGTH_FOR_QUOTE =
5000
-
POST_QUOTES_QUOTE_VALID_VALUES_FOR_COLLECTION_METHOD =
String.static_array("charge_automatically", "send_invoice")
-
POST_QUOTES_VALID_VALUES_FOR_COLLECTION_METHOD =
String.static_array("charge_automatically", "send_invoice")
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_quotes(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, customer : String | Nil = nil, status : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_quotes_quote(*, quote : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_quotes_quote_computed_upfront_line_items(*, quote : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_quotes_quote_line_items(*, quote : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_quotes_quote_pdf(*, quote : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_quotes(*, application_fee_amount : Stripe::PostQuotesRequestApplicationFeeAmount | Nil = nil, application_fee_percent : Stripe::PostQuotesRequestApplicationFeePercent | Nil = nil, automatic_tax : Stripe::AutomaticTaxParam | Nil = nil, collection_method : String | Nil = nil, customer : String | Nil = nil, default_tax_rates : Stripe::PostQuotesRequestDefaultTaxRates | Nil = nil, description : Stripe::PostQuotesRequestDescription | Nil = nil, discounts : Stripe::PostQuotesRequestDiscounts | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, footer : Stripe::PostQuotesRequestFooter | Nil = nil, from_quote : Stripe::FromQuoteParams | Nil = nil, header : Stripe::PostQuotesRequestHeader | Nil = nil, invoice_settings : Stripe::QuoteParam | Nil = nil, line_items : Array(Stripe::LineItemCreateParams) | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : Stripe::PostQuotesRequestOnBehalfOf | Nil = nil, subscription_data : Stripe::SubscriptionDataCreateParams | Nil = nil, test_clock : String | Nil = nil, transfer_data : Stripe::PostQuotesRequestTransferData | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_quotes_quote(*, quote : String | Nil = nil, application_fee_amount : Stripe::PostQuotesRequestApplicationFeeAmount | Nil = nil, application_fee_percent : Stripe::PostQuotesRequestApplicationFeePercent | Nil = nil, automatic_tax : Stripe::AutomaticTaxParam | Nil = nil, collection_method : String | Nil = nil, customer : String | Nil = nil, default_tax_rates : Stripe::PostQuotesRequestDefaultTaxRates | Nil = nil, description : Stripe::PostQuotesQuoteRequestDescription | Nil = nil, discounts : Stripe::PostQuotesRequestDiscounts | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, footer : Stripe::PostQuotesQuoteRequestFooter | Nil = nil, header : Stripe::PostQuotesQuoteRequestHeader | Nil = nil, invoice_settings : Stripe::QuoteParam | Nil = nil, line_items : Array(Stripe::LineItemUpdateParams) | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : Stripe::PostQuotesRequestOnBehalfOf | Nil = nil, subscription_data : Stripe::SubscriptionDataUpdateParams | Nil = nil, transfer_data : Stripe::PostQuotesRequestTransferData | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_quotes_quote_accept(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_quotes_quote_cancel(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_quotes_quote_finalize(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_quotes(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, customer : String | Nil = nil, status : String | Nil = nil) : Stripe::QuotesResourceQuoteList
Returns a list of your quotes.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_quotes(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, customer : String | Nil = nil, status : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of your quotes.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_quotes_quote(*, quote : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::Quote
Retrieves the quote with the given ID.
@required @param quote [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_quotes_quote(*, quote : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the quote with the given ID.</p> @required @param quote [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_quotes_quote_computed_upfront_line_items(*, quote : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::QuotesResourceListLineItems
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items.
-
#get_quotes_quote_computed_upfront_line_items(*, quote : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>When retrieving a quote, there is an includable <a href="https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items"><strong>computed.upfront.line_items</strong></a> property containing the first handful of those items.
-
#get_quotes_quote_computed_upfront_line_items_with_http_info(*, quote : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::QuotesResourceListLineItems, Int32, Hash(String, Array(String) | String))
<p>When retrieving a quote, there is an includable <a href="https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items"><strong>computed.upfront.line_items</strong></a> property containing the first handful of those items.
-
#get_quotes_quote_line_items(*, quote : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::QuotesResourceListLineItems
When retrieving a quote, there is an includable line_items property containing the first handful of those items.
-
#get_quotes_quote_line_items(*, quote : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>When retrieving a quote, there is an includable <strong>line_items</strong> property containing the first handful of those items.
-
#get_quotes_quote_line_items_with_http_info(*, quote : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::QuotesResourceListLineItems, Int32, Hash(String, Array(String) | String))
<p>When retrieving a quote, there is an includable <strong>line_items</strong> property containing the first handful of those items.
-
#get_quotes_quote_pdf(*, quote : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : ::File
Download the PDF for a finalized quote.
-
#get_quotes_quote_pdf(*, quote : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Download the PDF for a finalized quote.
-
#get_quotes_quote_pdf_with_http_info(*, quote : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(::File, Int32, Hash(String, Array(String) | String))
<p>Download the PDF for a finalized quote.
-
#get_quotes_quote_with_http_info(*, quote : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::Quote, Int32, Hash(String, Array(String) | String))
<p>Retrieves the quote with the given ID.</p> @required @param quote [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_quotes_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, customer : String | Nil = nil, status : String | Nil = nil) : Tuple(Stripe::QuotesResourceQuoteList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of your quotes.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#post_quotes(*, application_fee_amount : Stripe::PostQuotesRequestApplicationFeeAmount | Nil = nil, application_fee_percent : Stripe::PostQuotesRequestApplicationFeePercent | Nil = nil, automatic_tax : Stripe::AutomaticTaxParam | Nil = nil, collection_method : String | Nil = nil, customer : String | Nil = nil, default_tax_rates : Stripe::PostQuotesRequestDefaultTaxRates | Nil = nil, description : Stripe::PostQuotesRequestDescription | Nil = nil, discounts : Stripe::PostQuotesRequestDiscounts | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, footer : Stripe::PostQuotesRequestFooter | Nil = nil, from_quote : Stripe::FromQuoteParams | Nil = nil, header : Stripe::PostQuotesRequestHeader | Nil = nil, invoice_settings : Stripe::QuoteParam | Nil = nil, line_items : Array(Stripe::LineItemCreateParams) | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : Stripe::PostQuotesRequestOnBehalfOf | Nil = nil, subscription_data : Stripe::SubscriptionDataCreateParams | Nil = nil, test_clock : String | Nil = nil, transfer_data : Stripe::PostQuotesRequestTransferData | Nil = nil) : Stripe::Quote
A quote models prices and services for a customer.
-
#post_quotes(*, application_fee_amount : Stripe::PostQuotesRequestApplicationFeeAmount | Nil = nil, application_fee_percent : Stripe::PostQuotesRequestApplicationFeePercent | Nil = nil, automatic_tax : Stripe::AutomaticTaxParam | Nil = nil, collection_method : String | Nil = nil, customer : String | Nil = nil, default_tax_rates : Stripe::PostQuotesRequestDefaultTaxRates | Nil = nil, description : Stripe::PostQuotesRequestDescription | Nil = nil, discounts : Stripe::PostQuotesRequestDiscounts | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, footer : Stripe::PostQuotesRequestFooter | Nil = nil, from_quote : Stripe::FromQuoteParams | Nil = nil, header : Stripe::PostQuotesRequestHeader | Nil = nil, invoice_settings : Stripe::QuoteParam | Nil = nil, line_items : Array(Stripe::LineItemCreateParams) | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : Stripe::PostQuotesRequestOnBehalfOf | Nil = nil, subscription_data : Stripe::SubscriptionDataCreateParams | Nil = nil, test_clock : String | Nil = nil, transfer_data : Stripe::PostQuotesRequestTransferData | Nil = nil, &block : Crest::Response -> ) : Nil
<p>A quote models prices and services for a customer.
-
#post_quotes_quote(*, quote : String | Nil = nil, application_fee_amount : Stripe::PostQuotesRequestApplicationFeeAmount | Nil = nil, application_fee_percent : Stripe::PostQuotesRequestApplicationFeePercent | Nil = nil, automatic_tax : Stripe::AutomaticTaxParam | Nil = nil, collection_method : String | Nil = nil, customer : String | Nil = nil, default_tax_rates : Stripe::PostQuotesRequestDefaultTaxRates | Nil = nil, description : Stripe::PostQuotesQuoteRequestDescription | Nil = nil, discounts : Stripe::PostQuotesRequestDiscounts | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, footer : Stripe::PostQuotesQuoteRequestFooter | Nil = nil, header : Stripe::PostQuotesQuoteRequestHeader | Nil = nil, invoice_settings : Stripe::QuoteParam | Nil = nil, line_items : Array(Stripe::LineItemUpdateParams) | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : Stripe::PostQuotesRequestOnBehalfOf | Nil = nil, subscription_data : Stripe::SubscriptionDataUpdateParams | Nil = nil, transfer_data : Stripe::PostQuotesRequestTransferData | Nil = nil) : Stripe::Quote
A quote models prices and services for a customer.
@required @param quote [String?] @optional @param application_fee_amount [Stripe::PostQuotesRequestApplicationFeeAmount?] @optional @param application_fee_percent [Stripe::PostQuotesRequestApplicationFeePercent?] @optional @param automatic_tax [Stripe::AutomaticTaxParam?] @optional @param collection_method [String?] Either `charge_automatically`, or `send_invoice`. -
#post_quotes_quote(*, quote : String | Nil = nil, application_fee_amount : Stripe::PostQuotesRequestApplicationFeeAmount | Nil = nil, application_fee_percent : Stripe::PostQuotesRequestApplicationFeePercent | Nil = nil, automatic_tax : Stripe::AutomaticTaxParam | Nil = nil, collection_method : String | Nil = nil, customer : String | Nil = nil, default_tax_rates : Stripe::PostQuotesRequestDefaultTaxRates | Nil = nil, description : Stripe::PostQuotesQuoteRequestDescription | Nil = nil, discounts : Stripe::PostQuotesRequestDiscounts | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, footer : Stripe::PostQuotesQuoteRequestFooter | Nil = nil, header : Stripe::PostQuotesQuoteRequestHeader | Nil = nil, invoice_settings : Stripe::QuoteParam | Nil = nil, line_items : Array(Stripe::LineItemUpdateParams) | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : Stripe::PostQuotesRequestOnBehalfOf | Nil = nil, subscription_data : Stripe::SubscriptionDataUpdateParams | Nil = nil, transfer_data : Stripe::PostQuotesRequestTransferData | Nil = nil, &block : Crest::Response -> ) : Nil
<p>A quote models prices and services for a customer.</p> @required @param quote [String?] @optional @param application_fee_amount [Stripe::PostQuotesRequestApplicationFeeAmount?] @optional @param application_fee_percent [Stripe::PostQuotesRequestApplicationFeePercent?] @optional @param automatic_tax [Stripe::AutomaticTaxParam?] @optional @param collection_method [String?] Either
charge_automatically
, orsend_invoice
. -
#post_quotes_quote_accept(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::Quote
Accepts the specified quote.
@required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. -
#post_quotes_quote_accept(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Accepts the specified quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_quotes_quote_accept_with_http_info(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::Quote, Int32, Hash(String, Array(String) | String))
<p>Accepts the specified quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_quotes_quote_cancel(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::Quote
Cancels the quote.
@required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. -
#post_quotes_quote_cancel(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Cancels the quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_quotes_quote_cancel_with_http_info(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::Quote, Int32, Hash(String, Array(String) | String))
<p>Cancels the quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_quotes_quote_finalize(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil) : Stripe::Quote
Finalizes the quote.
@required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. -
#post_quotes_quote_finalize(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Finalizes the quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_quotes_quote_finalize_with_http_info(*, quote : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil) : Tuple(Stripe::Quote, Int32, Hash(String, Array(String) | String))
<p>Finalizes the quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_quotes_quote_with_http_info(*, quote : String | Nil = nil, application_fee_amount : Stripe::PostQuotesRequestApplicationFeeAmount | Nil = nil, application_fee_percent : Stripe::PostQuotesRequestApplicationFeePercent | Nil = nil, automatic_tax : Stripe::AutomaticTaxParam | Nil = nil, collection_method : String | Nil = nil, customer : String | Nil = nil, default_tax_rates : Stripe::PostQuotesRequestDefaultTaxRates | Nil = nil, description : Stripe::PostQuotesQuoteRequestDescription | Nil = nil, discounts : Stripe::PostQuotesRequestDiscounts | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, footer : Stripe::PostQuotesQuoteRequestFooter | Nil = nil, header : Stripe::PostQuotesQuoteRequestHeader | Nil = nil, invoice_settings : Stripe::QuoteParam | Nil = nil, line_items : Array(Stripe::LineItemUpdateParams) | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : Stripe::PostQuotesRequestOnBehalfOf | Nil = nil, subscription_data : Stripe::SubscriptionDataUpdateParams | Nil = nil, transfer_data : Stripe::PostQuotesRequestTransferData | Nil = nil) : Tuple(Stripe::Quote, Int32, Hash(String, Array(String) | String))
<p>A quote models prices and services for a customer.</p> @required @param quote [String?] @optional @param application_fee_amount [Stripe::PostQuotesRequestApplicationFeeAmount?] @optional @param application_fee_percent [Stripe::PostQuotesRequestApplicationFeePercent?] @optional @param automatic_tax [Stripe::AutomaticTaxParam?] @optional @param collection_method [String?] Either
charge_automatically
, orsend_invoice
. -
#post_quotes_with_http_info(*, application_fee_amount : Stripe::PostQuotesRequestApplicationFeeAmount | Nil = nil, application_fee_percent : Stripe::PostQuotesRequestApplicationFeePercent | Nil = nil, automatic_tax : Stripe::AutomaticTaxParam | Nil = nil, collection_method : String | Nil = nil, customer : String | Nil = nil, default_tax_rates : Stripe::PostQuotesRequestDefaultTaxRates | Nil = nil, description : Stripe::PostQuotesRequestDescription | Nil = nil, discounts : Stripe::PostQuotesRequestDiscounts | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, footer : Stripe::PostQuotesRequestFooter | Nil = nil, from_quote : Stripe::FromQuoteParams | Nil = nil, header : Stripe::PostQuotesRequestHeader | Nil = nil, invoice_settings : Stripe::QuoteParam | Nil = nil, line_items : Array(Stripe::LineItemCreateParams) | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : Stripe::PostQuotesRequestOnBehalfOf | Nil = nil, subscription_data : Stripe::SubscriptionDataCreateParams | Nil = nil, test_clock : String | Nil = nil, transfer_data : Stripe::PostQuotesRequestTransferData | Nil = nil) : Tuple(Stripe::Quote, Int32, Hash(String, Array(String) | String))
<p>A quote models prices and services for a customer.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Returns a list of your quotes.
@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param test_clock [String?] Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param customer [String?] The ID of the customer whose quotes will be retrieved. @optional @param status [String?] The status of the quote. @return [Stripe::QuotesResourceQuoteList]<p>Returns a list of your quotes.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param test_clock [String?] Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@optional @param customer [String?] The ID of the customer whose quotes will be retrieved.
@optional @param status [String?] The status of the quote.
@return nil
Retrieves the quote with the given ID.
@required @param quote [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::Quote]<p>Retrieves the quote with the given ID.</p> @required @param quote [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
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.
@required @param quote [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::QuotesResourceListLineItems]<p>When retrieving a quote, there is an includable <a href="https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items"><strong>computed.upfront.line_items</strong></a> 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.</p>
@required @param quote [String?]
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
<p>When retrieving a quote, there is an includable <a href="https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items"><strong>computed.upfront.line_items</strong></a> 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.</p>
@required @param quote [String?]
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::QuotesResourceListLineItems, Integer, Hash)] Stripe::QuotesResourceListLineItems, response status code and response headers
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.
@required @param quote [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::QuotesResourceListLineItems]<p>When retrieving a quote, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>
@required @param quote [String?]
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
<p>When retrieving a quote, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>
@required @param quote [String?]
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::QuotesResourceListLineItems, Integer, Hash)] Stripe::QuotesResourceListLineItems, response status code and response headers
Download the PDF for a finalized quote. Explanation for special handling can be found here
@required @param quote [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [::File]<p>Download the PDF for a finalized quote. Explanation for special handling can be found <a href="https://docs.stripe.com/quotes/overview#quote_pdf">here</a></p> @required @param quote [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Download the PDF for a finalized quote. Explanation for special handling can be found <a href="https://docs.stripe.com/quotes/overview#quote_pdf">here</a></p> @required @param quote [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(::File, Integer, Hash)] ::File, response status code and response headers
<p>Retrieves the quote with the given ID.</p> @required @param quote [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Quote, Integer, Hash)] Stripe::Quote, response status code and response headers
<p>Returns a list of your quotes.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param test_clock [String?] Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@optional @param customer [String?] The ID of the customer whose quotes will be retrieved.
@optional @param status [String?] The status of the quote.
@return [Tuple(Stripe::QuotesResourceQuoteList, Integer, Hash)] Stripe::QuotesResourceQuoteList, response status code and response headers
Accepts the specified quote.
@required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::Quote]<p>Accepts the specified quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Accepts the specified quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Quote, Integer, Hash)] Stripe::Quote, response status code and response headers
Cancels the quote.
@required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::Quote]<p>Cancels the quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Cancels the quote.</p> @required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Quote, Integer, Hash)] Stripe::Quote, response status code and response headers
Finalizes the quote.
@required @param quote [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. @return [Stripe::Quote]<p>Finalizes the quote.</p>
@required @param quote [String?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param expires_at [Int32?] A future timestamp on which the quote will be canceled if in open
or draft
status. Measured in seconds since the Unix epoch.
@return nil
<p>Finalizes the quote.</p>
@required @param quote [String?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param expires_at [Int32?] A future timestamp on which the quote will be canceled if in open
or draft
status. Measured in seconds since the Unix epoch.
@return [Tuple(Stripe::Quote, Integer, Hash)] Stripe::Quote, response status code and response headers