class Stripe::ClimateApi
- Stripe::ClimateApi
- Reference
- Object
Defined in:
stripe/api/climate_api.crConstant Summary
-
GET_CLIMATE_ORDERS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_CLIMATE_ORDERS_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_CLIMATE_ORDERS_ORDER_MAX_LENGTH_FOR_ORDER =
5000 -
GET_CLIMATE_PRODUCTS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_CLIMATE_PRODUCTS_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_CLIMATE_PRODUCTS_PRODUCT_MAX_LENGTH_FOR_PRODUCT =
5000 -
GET_CLIMATE_SUPPLIERS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_CLIMATE_SUPPLIERS_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_CLIMATE_SUPPLIERS_SUPPLIER_MAX_LENGTH_FOR_SUPPLIER =
5000 -
POST_CLIMATE_ORDERS_MAX_LENGTH_FOR_CURRENCY =
5000 -
POST_CLIMATE_ORDERS_MAX_LENGTH_FOR_PRODUCT =
5000 -
POST_CLIMATE_ORDERS_ORDER_CANCEL_MAX_LENGTH_FOR_ORDER =
5000 -
POST_CLIMATE_ORDERS_ORDER_MAX_LENGTH_FOR_ORDER =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_climate_orders(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_climate_orders_order(*, order : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_climate_products(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_climate_products_product(*, product : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_climate_suppliers(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_climate_suppliers_supplier(*, supplier : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_climate_orders(*, product : String | Nil = nil, amount : Int64 | Nil = nil, beneficiary : Stripe::BeneficiaryParams | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, metric_tons : BigDecimal | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_climate_orders_order(*, order : String | Nil = nil, beneficiary : Stripe::PostClimateOrdersOrderRequestBeneficiary | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_climate_orders_order_cancel(*, order : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_climate_orders(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ClimateRemovalsOrdersList
Lists all Climate order objects.
-
#get_climate_orders(*, 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>Lists all Climate order objects.
-
#get_climate_orders_order(*, order : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ClimateOrder
Retrieves the details of a Climate order object with the given ID.
@required @param order [String?] Unique identifier of the order. -
#get_climate_orders_order(*, order : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the details of a Climate order object with the given ID.</p> @required @param order [String?] Unique identifier of the order.
-
#get_climate_orders_order_with_http_info(*, order : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ClimateOrder, Int32, Hash(String, Array(String) | String))
<p>Retrieves the details of a Climate order object with the given ID.</p> @required @param order [String?] Unique identifier of the order.
-
#get_climate_orders_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ClimateRemovalsOrdersList, Int32, Hash(String, Array(String) | String))
<p>Lists all Climate order objects.
-
#get_climate_products(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ClimateRemovalsProductsList
Lists all available Climate product objects.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_climate_products(*, 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>Lists all available Climate product objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_climate_products_product(*, product : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ClimateProduct
Retrieves the details of a Climate product with the given ID.
@required @param product [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_climate_products_product(*, product : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the details of a Climate product with the given ID.</p> @required @param product [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_climate_products_product_with_http_info(*, product : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ClimateProduct, Int32, Hash(String, Array(String) | String))
<p>Retrieves the details of a Climate product with the given ID.</p> @required @param product [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_climate_products_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ClimateRemovalsProductsList, Int32, Hash(String, Array(String) | String))
<p>Lists all available Climate product objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_climate_suppliers(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ClimateRemovalsSuppliersList
Lists all available Climate supplier objects.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_climate_suppliers(*, 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>Lists all available Climate supplier objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_climate_suppliers_supplier(*, supplier : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ClimateSupplier
Retrieves a Climate supplier object.
@required @param supplier [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_climate_suppliers_supplier(*, supplier : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a Climate supplier object.</p> @required @param supplier [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_climate_suppliers_supplier_with_http_info(*, supplier : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ClimateSupplier, Int32, Hash(String, Array(String) | String))
<p>Retrieves a Climate supplier object.</p> @required @param supplier [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_climate_suppliers_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ClimateRemovalsSuppliersList, Int32, Hash(String, Array(String) | String))
<p>Lists all available Climate supplier objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#post_climate_orders(*, product : String | Nil = nil, amount : Int64 | Nil = nil, beneficiary : Stripe::BeneficiaryParams | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, metric_tons : BigDecimal | Nil = nil) : Stripe::ClimateOrder
Creates a Climate order object for a given Climate product.
-
#post_climate_orders(*, product : String | Nil = nil, amount : Int64 | Nil = nil, beneficiary : Stripe::BeneficiaryParams | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, metric_tons : BigDecimal | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a Climate order object for a given Climate product.
-
#post_climate_orders_order(*, order : String | Nil = nil, beneficiary : Stripe::PostClimateOrdersOrderRequestBeneficiary | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Stripe::ClimateOrder
Updates the specified order by setting the values of the parameters passed.
@required @param order [String?] Unique identifier of the order. -
#post_climate_orders_order(*, order : String | Nil = nil, beneficiary : Stripe::PostClimateOrdersOrderRequestBeneficiary | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates the specified order by setting the values of the parameters passed.</p> @required @param order [String?] Unique identifier of the order.
-
#post_climate_orders_order_cancel(*, order : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::ClimateOrder
Cancels a Climate order.
-
#post_climate_orders_order_cancel(*, order : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Cancels a Climate order.
-
#post_climate_orders_order_cancel_with_http_info(*, order : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::ClimateOrder, Int32, Hash(String, Array(String) | String))
<p>Cancels a Climate order.
-
#post_climate_orders_order_with_http_info(*, order : String | Nil = nil, beneficiary : Stripe::PostClimateOrdersOrderRequestBeneficiary | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Tuple(Stripe::ClimateOrder, Int32, Hash(String, Array(String) | String))
<p>Updates the specified order by setting the values of the parameters passed.</p> @required @param order [String?] Unique identifier of the order.
-
#post_climate_orders_with_http_info(*, product : String | Nil = nil, amount : Int64 | Nil = nil, beneficiary : Stripe::BeneficiaryParams | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, metric_tons : BigDecimal | Nil = nil) : Tuple(Stripe::ClimateOrder, Int32, Hash(String, Array(String) | String))
<p>Creates a Climate order object for a given Climate product.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.
@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::ClimateRemovalsOrdersList]<p>Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.</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 expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the details of a Climate order object with the given ID.
@required @param order [String?] Unique identifier of the order. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ClimateOrder]<p>Retrieves the details of a Climate order object with the given ID.</p> @required @param order [String?] Unique identifier of the order. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the details of a Climate order object with the given ID.</p> @required @param order [String?] Unique identifier of the order. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ClimateOrder, Integer, Hash)] Stripe::ClimateOrder, response status code and response headers
<p>Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.</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 expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::ClimateRemovalsOrdersList, Integer, Hash)] Stripe::ClimateRemovalsOrdersList, response status code and response headers
Lists all available Climate product objects.
@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::ClimateRemovalsProductsList]<p>Lists all available Climate product objects.</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 expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the details of a Climate product with the given ID.
@required @param product [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ClimateProduct]<p>Retrieves the details of a Climate product with the given ID.</p> @required @param product [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the details of a Climate product with the given ID.</p> @required @param product [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ClimateProduct, Integer, Hash)] Stripe::ClimateProduct, response status code and response headers
<p>Lists all available Climate product objects.</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 expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::ClimateRemovalsProductsList, Integer, Hash)] Stripe::ClimateRemovalsProductsList, response status code and response headers
Lists all available Climate supplier objects.
@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::ClimateRemovalsSuppliersList]<p>Lists all available Climate supplier objects.</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 expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves a Climate supplier object.
@required @param supplier [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ClimateSupplier]<p>Retrieves a Climate supplier object.</p> @required @param supplier [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a Climate supplier object.</p> @required @param supplier [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ClimateSupplier, Integer, Hash)] Stripe::ClimateSupplier, response status code and response headers
<p>Lists all available Climate supplier objects.</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 expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::ClimateRemovalsSuppliersList, Integer, Hash)] Stripe::ClimateRemovalsSuppliersList, response status code and response headers
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.
@required @param product [String?] Unique identifier of the Climate product. @optional @param amount [Int32?] Requested amount of carbon removal units. Either this or `metric_tons` must be specified. @optional @param beneficiary [Stripe::BeneficiaryParams?] @optional @param currency [String?] Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param metric_tons [BigDecimal?] Requested number of tons for the order. Either this or `amount` must be specified. @return [Stripe::ClimateOrder]<p>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.</p>
@required @param product [String?] Unique identifier of the Climate product.
@optional @param amount [Int32?] Requested amount of carbon removal units. Either this or metric_tons must be specified.
@optional @param beneficiary [Stripe::BeneficiaryParams?]
@optional @param currency [String?] Request currency for the order as a three-letter ISO currency code, in lowercase. Must be a supported settlement currency for your account. If omitted, the account's default currency will be used.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param metadata [Hash(String, String)?]
@optional @param metric_tons [BigDecimal?] Requested number of tons for the order. Either this or amount must be specified.
@return nil
Updates the specified order by setting the values of the parameters passed.
@required @param order [String?] Unique identifier of the order. @optional @param beneficiary [Stripe::PostClimateOrdersOrderRequestBeneficiary?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return [Stripe::ClimateOrder]<p>Updates the specified order by setting the values of the parameters passed.</p> @required @param order [String?] Unique identifier of the order. @optional @param beneficiary [Stripe::PostClimateOrdersOrderRequestBeneficiary?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return nil
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.
<p>Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation <code>amount_subtotal</code>, but not the <code>amount_fees</code> 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 <code>amount_total</code>.</p> @required @param order [String?] Unique identifier of the order. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation <code>amount_subtotal</code>, but not the <code>amount_fees</code> 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 <code>amount_total</code>.</p> @required @param order [String?] Unique identifier of the order. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ClimateOrder, Integer, Hash)] Stripe::ClimateOrder, response status code and response headers
<p>Updates the specified order by setting the values of the parameters passed.</p> @required @param order [String?] Unique identifier of the order. @optional @param beneficiary [Stripe::PostClimateOrdersOrderRequestBeneficiary?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return [Tuple(Stripe::ClimateOrder, Integer, Hash)] Stripe::ClimateOrder, response status code and response headers
<p>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.</p>
@required @param product [String?] Unique identifier of the Climate product.
@optional @param amount [Int32?] Requested amount of carbon removal units. Either this or metric_tons must be specified.
@optional @param beneficiary [Stripe::BeneficiaryParams?]
@optional @param currency [String?] Request currency for the order as a three-letter ISO currency code, in lowercase. Must be a supported settlement currency for your account. If omitted, the account's default currency will be used.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param metadata [Hash(String, String)?]
@optional @param metric_tons [BigDecimal?] Requested number of tons for the order. Either this or amount must be specified.
@return [Tuple(Stripe::ClimateOrder, Integer, Hash)] Stripe::ClimateOrder, response status code and response headers