class

Stripe::Quote

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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.

Constants

ERROR_MESSAGE_FOR_COLLECTION_METHOD = "invalid value for \"collection_method\", must be one of [charge_automatically, send_invoice]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [quote]."

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [accepted, canceled, draft, open]."

MAX_LENGTH_FOR_CURRENCY = 5000

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_FOOTER = 5000

MAX_LENGTH_FOR_HEADER = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_NUMBER = 5000

VALID_VALUES_FOR_COLLECTION_METHOD = String.static_array("charge_automatically", "send_invoice")

VALID_VALUES_FOR_OBJECT = String.static_array("quote")

VALID_VALUES_FOR_STATUS = String.static_array("accepted", "canceled", "draft", "open")

Constructors

new(pull : JSON::PullParser)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

new(*, amount_subtotal : Int64 | Nil = nil, amount_total : Int64 | Nil = nil, application : Stripe::QuoteApplication | Nil = nil, application_fee_amount : Int64 | Nil = nil, application_fee_percent : Float64 | Nil = nil, automatic_tax : Stripe::QuotesResourceAutomaticTax | Nil = nil, collection_method : String | Nil = nil, computed : Stripe::QuotesResourceComputed | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, customer : Stripe::QuoteCustomer | Nil = nil, description : String | Nil = nil, discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil = nil, expires_at : Int64 | Nil = nil, footer : String | Nil = nil, from_quote : Stripe::QuoteFromQuote | Nil = nil, header : String | Nil = nil, id : String | Nil = nil, invoice : Stripe::QuoteInvoice | Nil = nil, invoice_settings : Stripe::InvoiceSettingQuoteSetting | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, number : String | Nil = nil, object : String | Nil = nil, on_behalf_of : Stripe::PaymentLinkOnBehalfOf | Nil = nil, status : String | Nil = nil, status_transitions : Stripe::QuotesResourceStatusTransitions | Nil = nil, subscription : Stripe::QuoteSubscription | Nil = nil, subscription_data : Stripe::QuotesResourceSubscriptionDataSubscriptionData | Nil = nil, subscription_schedule : Stripe::QuoteSubscriptionSchedule | Nil = nil, test_clock : Stripe::QuoteTestClock | Nil = nil, total_details : Stripe::QuotesResourceTotalDetails | Nil = nil, transfer_data : Stripe::QuoteTransferData | Nil = nil, default_tax_rates : Array(Stripe::QuoteDefaultTaxRatesInner) | Nil = nil, line_items : Stripe::QuotesResourceListLineItems | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

amount_subtotal

Total before any discounts or taxes are applied.

Source

amount_subtotal=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount_subtotal Object to be assigned

Source

amount_total

Total after discounts and taxes are applied.

Source

amount_total=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount_total Object to be assigned

Source

application

Source

application=(new_value : Stripe::QuoteApplication | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] application Object to be assigned

Source

application_fee_amount

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.

Source

application_fee_amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] application_fee_amount Object to be assigned

Source

application_fee_percent

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.

Source

application_fee_percent=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] application_fee_percent Object to be assigned

Source

automatic_tax

Source

automatic_tax=(new_value : Stripe::QuotesResourceAutomaticTax | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] automatic_tax Object to be assigned

Source

collection_method

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.

Source

collection_method=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] collection_method Object to be assigned

Source

computed

Source

computed=(new_value : Stripe::QuotesResourceComputed | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] computed Object to be assigned

Source

created

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

Source

created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source

currency

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

Source

currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

Source

customer

Source

customer=(new_value : Stripe::QuoteCustomer | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] customer Object to be assigned

Source

default_tax_rates

The tax rates applied to this quote.

Source

default_tax_rates=(new_value : Array(Stripe::QuoteDefaultTaxRatesInner) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] default_tax_rates Object to be assigned

Source

description

A description that will be displayed on the quote PDF.

Source

description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned

Source

discounts

The discounts applied to this quote.

Source

discounts=(new_value : Array(Stripe::InvoiceitemDiscountsInner) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] discounts Object to be assigned

Source

expires_at

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

Source

expires_at=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expires_at Object to be assigned

Source

from_quote

Source

from_quote=(new_value : Stripe::QuoteFromQuote | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] from_quote Object to be assigned

Source

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

header

A header that will be displayed on the quote PDF.

Source

Unique identifier for the object.

Source

id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source

invoice

Source

invoice=(new_value : Stripe::QuoteInvoice | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] invoice Object to be assigned

Source

invoice_settings

Source

invoice_settings=(new_value : Stripe::InvoiceSettingQuoteSetting | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] invoice_settings Object to be assigned

Source

line_items

Source

line_items=(new_value : Stripe::QuotesResourceListLineItems | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] line_items Object to be assigned

Source

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source

livemode

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

Source

livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source

metadata

Source

metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source

number

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

Source

number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] number Object to be assigned

Source

object

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

Source

object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source

on_behalf_of

Source

on_behalf_of=(new_value : Stripe::PaymentLinkOnBehalfOf | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] on_behalf_of Object to be assigned

Source

status

The status of the quote.

Source

status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source

status_transitions

Source

status_transitions=(new_value : Stripe::QuotesResourceStatusTransitions | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status_transitions Object to be assigned

Source

subscription

Source

subscription=(new_value : Stripe::QuoteSubscription | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] subscription Object to be assigned

Source

subscription_data

Source

subscription_data=(new_value : Stripe::QuotesResourceSubscriptionDataSubscriptionData | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] subscription_data Object to be assigned

Source

subscription_schedule

Source

subscription_schedule=(new_value : Stripe::QuoteSubscriptionSchedule | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] subscription_schedule Object to be assigned

Source

test_clock

Source

test_clock=(new_value : Stripe::QuoteTestClock | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] test_clock Object to be assigned

Source

total_details

Source

total_details=(new_value : Stripe::QuotesResourceTotalDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] total_details Object to be assigned

Source

transfer_data

Source

transfer_data=(new_value : Stripe::QuoteTransferData | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transfer_data Object to be assigned

Source

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source