class Stripe::Quote

• Stripe::Quote
• Reference
• Object

Overview

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.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

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)
• .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

Instance Method Summary

• #==(other : self)

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

• #amount_subtotal : Int64 | Nil
• #amount_subtotal=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #amount_total : Int64 | Nil
• #amount_total=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #application_fee_amount : Int64 | Nil
• #application_fee_amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #application_fee_percent : Float64 | Nil
• #application_fee_percent=(new_value : Float64 | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #collection_method : String | Nil
• #collection_method=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #description : String | Nil
• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #expires_at : Int64 | Nil
• #expires_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #footer : String | Nil
• #footer=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #header : String | Nil
• #header=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #number : String | Nil
• #number=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #status : String | Nil
• #status=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail