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]
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. 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
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]
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. 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]
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. 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
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. 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
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. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.
@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`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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`.
@optional @param customer [String?] The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
@optional @param default_tax_rates [Stripe::PostQuotesRequestDefaultTaxRates?]
@optional @param description [Stripe::PostQuotesRequestDescription?]
@optional @param discounts [Stripe::PostQuotesRequestDiscounts?]
@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. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
@optional @param footer [Stripe::PostQuotesRequestFooter?]
@optional @param from_quote [Stripe::FromQuoteParams?]
@optional @param header [Stripe::PostQuotesRequestHeader?]
@optional @param invoice_settings [Stripe::QuoteParam?]
@optional @param line_items [Array(Stripe::LineItemCreateParams)?] A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
@optional @param metadata [Hash(String, String)?]
@optional @param on_behalf_of [Stripe::PostQuotesRequestOnBehalfOf?]
@optional @param subscription_data [Stripe::SubscriptionDataCreateParams?]
@optional @param test_clock [String?] ID of the test clock to attach to the quote.
@optional @param transfer_data [Stripe::PostQuotesRequestTransferData?]
@return [Stripe::Quote]
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. Default options for <code>header</code>, <code>description</code>, <code>footer</code>, and <code>expires_at</code> can be set in the dashboard via the <a href="https://dashboard.stripe.com/settings/billing/quote">quote template</a>.</p>
@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. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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.
@optional @param customer [String?] The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
@optional @param default_tax_rates [Stripe::PostQuotesRequestDefaultTaxRates?]
@optional @param description [Stripe::PostQuotesRequestDescription?]
@optional @param discounts [Stripe::PostQuotesRequestDiscounts?]
@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. If no value is passed, the default expiration date configured in your quote template settings will be used.
@optional @param footer [Stripe::PostQuotesRequestFooter?]
@optional @param from_quote [Stripe::FromQuoteParams?]
@optional @param header [Stripe::PostQuotesRequestHeader?]
@optional @param invoice_settings [Stripe::QuoteParam?]
@optional @param line_items [Array(Stripe::LineItemCreateParams)?] A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
@optional @param metadata [Hash(String, String)?]
@optional @param on_behalf_of [Stripe::PostQuotesRequestOnBehalfOf?]
@optional @param subscription_data [Stripe::SubscriptionDataCreateParams?]
@optional @param test_clock [String?] ID of the test clock to attach to the quote.
@optional @param transfer_data [Stripe::PostQuotesRequestTransferData?]
@return nil
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`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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`.
@optional @param customer [String?] The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
@optional @param default_tax_rates [Stripe::PostQuotesRequestDefaultTaxRates?]
@optional @param description [Stripe::PostQuotesQuoteRequestDescription?]
@optional @param discounts [Stripe::PostQuotesRequestDiscounts?]
@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.
@optional @param footer [Stripe::PostQuotesQuoteRequestFooter?]
@optional @param header [Stripe::PostQuotesQuoteRequestHeader?]
@optional @param invoice_settings [Stripe::QuoteParam?]
@optional @param line_items [Array(Stripe::LineItemUpdateParams)?] A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
@optional @param metadata [Hash(String, String)?]
@optional @param on_behalf_of [Stripe::PostQuotesRequestOnBehalfOf?]
@optional @param subscription_data [Stripe::SubscriptionDataUpdateParams?]
@optional @param transfer_data [Stripe::PostQuotesRequestTransferData?]
@return [Stripe::Quote]
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, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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.
@optional @param customer [String?] The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
@optional @param default_tax_rates [Stripe::PostQuotesRequestDefaultTaxRates?]
@optional @param description [Stripe::PostQuotesQuoteRequestDescription?]
@optional @param discounts [Stripe::PostQuotesRequestDiscounts?]
@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.
@optional @param footer [Stripe::PostQuotesQuoteRequestFooter?]
@optional @param header [Stripe::PostQuotesQuoteRequestHeader?]
@optional @param invoice_settings [Stripe::QuoteParam?]
@optional @param line_items [Array(Stripe::LineItemUpdateParams)?] A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
@optional @param metadata [Hash(String, String)?]
@optional @param on_behalf_of [Stripe::PostQuotesRequestOnBehalfOf?]
@optional @param subscription_data [Stripe::SubscriptionDataUpdateParams?]
@optional @param transfer_data [Stripe::PostQuotesRequestTransferData?]
@return nil
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]
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.
@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]
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.
@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]
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.
@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
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, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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.
@optional @param customer [String?] The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
@optional @param default_tax_rates [Stripe::PostQuotesRequestDefaultTaxRates?]
@optional @param description [Stripe::PostQuotesQuoteRequestDescription?]
@optional @param discounts [Stripe::PostQuotesRequestDiscounts?]
@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.
@optional @param footer [Stripe::PostQuotesQuoteRequestFooter?]
@optional @param header [Stripe::PostQuotesQuoteRequestHeader?]
@optional @param invoice_settings [Stripe::QuoteParam?]
@optional @param line_items [Array(Stripe::LineItemUpdateParams)?] A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
@optional @param metadata [Hash(String, String)?]
@optional @param on_behalf_of [Stripe::PostQuotesRequestOnBehalfOf?]
@optional @param subscription_data [Stripe::SubscriptionDataUpdateParams?]
@optional @param transfer_data [Stripe::PostQuotesRequestTransferData?]
@return [Tuple(Stripe::Quote, Integer, Hash)] Stripe::Quote, response status code and response headers
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. Default options for <code>header</code>, <code>description</code>, <code>footer</code>, and <code>expires_at</code> can be set in the dashboard via the <a href="https://dashboard.stripe.com/settings/billing/quote">quote template</a>.</p>
@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. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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.
@optional @param customer [String?] The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
@optional @param default_tax_rates [Stripe::PostQuotesRequestDefaultTaxRates?]
@optional @param description [Stripe::PostQuotesRequestDescription?]
@optional @param discounts [Stripe::PostQuotesRequestDiscounts?]
@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. If no value is passed, the default expiration date configured in your quote template settings will be used.
@optional @param footer [Stripe::PostQuotesRequestFooter?]
@optional @param from_quote [Stripe::FromQuoteParams?]
@optional @param header [Stripe::PostQuotesRequestHeader?]
@optional @param invoice_settings [Stripe::QuoteParam?]
@optional @param line_items [Array(Stripe::LineItemCreateParams)?] A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
@optional @param metadata [Hash(String, String)?]
@optional @param on_behalf_of [Stripe::PostQuotesRequestOnBehalfOf?]
@optional @param subscription_data [Stripe::SubscriptionDataCreateParams?]
@optional @param test_clock [String?] ID of the test clock to attach to the quote.
@optional @param transfer_data [Stripe::PostQuotesRequestTransferData?]
@return [Tuple(Stripe::Quote, Integer, Hash)] Stripe::Quote, response status code and response headers