Class: Stripe::Climate::Order

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/climate/order.rb

Overview

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

Defined Under Namespace

Classes: Beneficiary, CancelParams, CreateParams, DeliveryDetail, ListParams, RetrieveParams, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"climate.order"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#amount_fees ⇒ Object (readonly)

Total amount of [Frontier](frontierclimate.com/)‘s service fees in the currency’s smallest unit.



169
170
171
 
# File 'lib/stripe/resources/climate/order.rb', line 169

def amount_fees
  @amount_fees
end

#amount_subtotal ⇒ Object (readonly)

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



172
173
174
 
# File 'lib/stripe/resources/climate/order.rb', line 172

def amount_subtotal
  @amount_subtotal
end

#amount_total ⇒ Object (readonly)

Total amount of the order including fees in the currency’s smallest unit.



175
176
177
 
# File 'lib/stripe/resources/climate/order.rb', line 175

def amount_total
  @amount_total
end

#beneficiary ⇒ Object (readonly)

Attribute for field beneficiary



178
179
180
 
# File 'lib/stripe/resources/climate/order.rb', line 178

def beneficiary
  @beneficiary
end

#canceled_at ⇒ Object (readonly)

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



181
182
183
 
# File 'lib/stripe/resources/climate/order.rb', line 181

def canceled_at
  @canceled_at
end

#cancellation_reason ⇒ Object (readonly)

Reason for the cancellation of this order.



184
185
186
 
# File 'lib/stripe/resources/climate/order.rb', line 184

def cancellation_reason
  @cancellation_reason
end

#certificate ⇒ Object (readonly)

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



187
188
189
 
# File 'lib/stripe/resources/climate/order.rb', line 187

def certificate
  @certificate
end

#confirmed_at ⇒ Object (readonly)

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



190
191
192
 
# File 'lib/stripe/resources/climate/order.rb', line 190

def confirmed_at
  @confirmed_at
end

#created ⇒ Object (readonly)

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



193
194
195
 
# File 'lib/stripe/resources/climate/order.rb', line 193

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.



196
197
198
 
# File 'lib/stripe/resources/climate/order.rb', line 196

def currency
  @currency
end

#delayed_at ⇒ Object (readonly)

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



199
200
201
 
# File 'lib/stripe/resources/climate/order.rb', line 199

def delayed_at
  @delayed_at
end

#delivered_at ⇒ Object (readonly)

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



202
203
204
 
# File 'lib/stripe/resources/climate/order.rb', line 202

def delivered_at
  @delivered_at
end

#delivery_details ⇒ Object (readonly)

Details about the delivery of carbon removal for this order.



205
206
207
 
# File 'lib/stripe/resources/climate/order.rb', line 205

def delivery_details
  @delivery_details
end

#expected_delivery_year ⇒ Object (readonly)

The year this order is expected to be delivered.



208
209
210
 
# File 'lib/stripe/resources/climate/order.rb', line 208

def expected_delivery_year
  @expected_delivery_year
end

#id ⇒ Object (readonly)

Unique identifier for the object.



211
212
213
 
# File 'lib/stripe/resources/climate/order.rb', line 211

def id
  @id
end

#livemode ⇒ Object (readonly)

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



214
215
216
 
# File 'lib/stripe/resources/climate/order.rb', line 214

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



217
218
219
 
# File 'lib/stripe/resources/climate/order.rb', line 217

def metadata
  @metadata
end

#metric_tons ⇒ Object (readonly)

Quantity of carbon removal that is included in this order.



220
221
222
 
# File 'lib/stripe/resources/climate/order.rb', line 220

def metric_tons
  @metric_tons
end

#object ⇒ Object (readonly)

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



223
224
225
 
# File 'lib/stripe/resources/climate/order.rb', line 223

def object
  @object
end

#product ⇒ Object (readonly)

Unique ID for the Climate ‘Product` this order is purchasing.



226
227
228
 
# File 'lib/stripe/resources/climate/order.rb', line 226

def product
  @product
end

#product_substituted_at ⇒ Object (readonly)

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



229
230
231
 
# File 'lib/stripe/resources/climate/order.rb', line 229

def product_substituted_at
  @product_substituted_at
end

#status ⇒ Object (readonly)

The current status of this order.



232
233
234
 
# File 'lib/stripe/resources/climate/order.rb', line 232

def status
  @status
end

Class Method Details

.cancel(order, params = {}, opts = {}) ⇒ Object

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the amount_total.



251
252
253
254
255
256
257
258
 
# File 'lib/stripe/resources/climate/order.rb', line 251

def self.cancel(order, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/climate/orders/%<order>s/cancel", { order: CGI.escape(order) }),
    params: params,
    opts: opts
  )
end

.create(params = {}, opts = {}) ⇒ Object

Creates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.



262
263
264
 
# File 'lib/stripe/resources/climate/order.rb', line 262

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/climate/orders", params: params, opts: opts)
end

.list(params = {}, opts = {}) ⇒ Object

Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.



268
269
270
 
# File 'lib/stripe/resources/climate/order.rb', line 268

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/climate/orders", params: params, opts: opts)
end

.object_name ⇒ Object 



14
15
16
 
# File 'lib/stripe/resources/climate/order.rb', line 14

def self.object_name
  "climate.order"
end

.update(id, params = {}, opts = {}) ⇒ Object

Updates the specified order by setting the values of the parameters passed.



273
274
275
276
277
278
279
280
 
# File 'lib/stripe/resources/climate/order.rb', line 273

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/climate/orders/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#cancel(params = {}, opts = {}) ⇒ Object

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the amount_total.



238
239
240
241
242
243
244
245
 
# File 'lib/stripe/resources/climate/order.rb', line 238

def cancel(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/climate/orders/%<order>s/cancel", { order: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end