class

Stripe::ClimateOrder

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

Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.

Constants

ERROR_MESSAGE_FOR_CANCELLATION_REASON = "invalid value for \"cancellation_reason\", must be one of [expired, product_unavailable, requested]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [climate.order]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [awaiting_funds, canceled, confirmed, delivered, open]."
MAX_LENGTH_FOR_CERTIFICATE = 5000
MAX_LENGTH_FOR_CURRENCY = 5000
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR_CANCELLATION_REASON = String.static_array("expired", "product_unavailable", "requested")
VALID_VALUES_FOR_OBJECT = String.static_array("climate.order")
VALID_VALUES_FOR_STATUS = String.static_array("awaiting_funds", "canceled", "confirmed", "delivered", "open")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount_fees : Int64 | Nil = nil, amount_subtotal : Int64 | Nil = nil, amount_total : Int64 | Nil = nil, canceled_at : Int64 | Nil = nil, cancellation_reason : String | Nil = nil, certificate : String | Nil = nil, confirmed_at : Int64 | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, delayed_at : Int64 | Nil = nil, delivered_at : Int64 | Nil = nil, delivery_details : Array(Stripe::ClimateRemovalsOrderDeliveries) | Nil = nil, expected_delivery_year : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, metric_tons : BigDecimal | Nil = nil, object : String | Nil = nil, product : Stripe::ClimateOrderProduct | Nil = nil, product_substituted_at : Int64 | Nil = nil, status : String | Nil = nil, beneficiary : Stripe::ClimateRemovalsBeneficiary | 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_fees

Total amount of Frontier's service fees in the currency's smallest unit.

Source
amount_fees=(new_value : Int64 | Nil)

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

Source
amount_subtotal

Total amount of the carbon removal in the currency's smallest unit.

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 amount of the order including fees in the currency's smallest unit.

Source
amount_total=(new_value : Int64 | Nil)

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

Source
beneficiary
Source
beneficiary=(new_value : Stripe::ClimateRemovalsBeneficiary | Nil)

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

Source
canceled_at

Time at which the order was canceled. Measured in seconds since the Unix epoch.

Source
canceled_at=(new_value : Int64 | Nil)

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

Source
cancellation_reason

Reason for the cancellation of this order.

Source
cancellation_reason=(new_value : String | Nil)

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

Source
certificate

For delivered orders, a URL to a delivery certificate for the order.

Source
certificate=(new_value : String | Nil)

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

Source
confirmed_at

Time at which the order was confirmed. Measured in seconds since the Unix epoch.

Source
confirmed_at=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] confirmed_at 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, representing the currency for this order.

Source
currency=(new_value : String | Nil)

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

Source
delayed_at

Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.

Source
delayed_at=(new_value : Int64 | Nil)

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

Source
delivered_at

Time at which the order was delivered. Measured in seconds since the Unix epoch.

Source
delivered_at=(new_value : Int64 | Nil)

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

Source
delivery_details

Details about the delivery of carbon removal for this order.

Source
delivery_details=(new_value : Array(Stripe::ClimateRemovalsOrderDeliveries) | Nil)

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

Source
expected_delivery_year

The year this order is expected to be delivered.

Source
expected_delivery_year=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expected_delivery_year 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

id

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
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
metric_tons

Quantity of carbon removal that is included in this order.

Source
metric_tons=(new_value : BigDecimal | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metric_tons 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
product
Source
product=(new_value : Stripe::ClimateOrderProduct | Nil)

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

Source
product_substituted_at

Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.

Source
product_substituted_at=(new_value : Int64 | Nil)

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

Source
status

The current status of this order.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status 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