Stripe Climate API
Stripe Climate is the easiest way to help promising permanent carbon removal technologies launch and scale. Join a growing group of ambitious businesses that are changing the course of carbon removal.
OpenAPI Specification
openapi: 3.0.0
info:
title: Stripe Climate API
description: Needs description.
contact:
email: [email protected]
name: Stripe Dev Platform Team
url: https://stripe.com
termsOfService: https://stripe.com/us/terms/
version: '2023-10-16'
x-stripeSpecFilename: spec3
security:
- basicAuth: []
- bearerAuth: []
servers:
- url: https://api.stripe.com/
paths:
/v1/climate/orders:
get:
description: >-
<p>Lists all Climate order objects. The orders are returned sorted by
creation date, with the
most recently created orders appearing first.</p>
operationId: getClimateOrders
parameters:
- description: >-
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.
in: query
name: ending_before
required: false
schema:
maxLength: 5000
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: >-
A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: >-
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.
in: query
name: starting_after
required: false
schema:
maxLength: 5000
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
$ref: '#/components/schemas/GetClimateOrdersRequest'
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
x-expandableFields:
- data
$ref: '#/components/schemas/ClimateRemovalsOrdersList'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Get Climate Orders
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
post:
description: >-
<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>
operationId: postClimateOrders
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
beneficiary:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostClimateOrdersRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.order'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Climate Orders
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/orders/{order}:
get:
description: >-
<p>Retrieves the details of a Climate order object with the given
ID.</p>
operationId: getClimateOrdersOrder
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: Unique identifier of the order.
in: path
name: order
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
$ref: '#/components/schemas/GetClimateOrdersOrderRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.order'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Get Climate Orders Order
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
post:
description: >-
<p>Updates the specified order by setting the values of the parameters
passed.</p>
operationId: postClimateOrdersOrder
parameters:
- description: Unique identifier of the order.
in: path
name: order
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
beneficiary:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostClimateOrdersOrderRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.order'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Climate Orders Order
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/orders/{order}/cancel:
post:
description: >-
<p>Cancels a Climate order. You can cancel an order within 30 days 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>
operationId: postClimateOrdersOrderCancel
parameters:
- description: Unique identifier of the order.
in: path
name: order
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostClimateOrdersOrderCancelRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.order'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Climate Orders Order Cancel
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/products:
get:
description: <p>Lists all available Climate product objects.</p>
operationId: getClimateProducts
parameters:
- description: >-
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.
in: query
name: ending_before
required: false
schema:
maxLength: 5000
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: >-
A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: >-
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.
in: query
name: starting_after
required: false
schema:
maxLength: 5000
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
$ref: '#/components/schemas/GetClimateProductsRequest'
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
x-expandableFields:
- data
$ref: '#/components/schemas/ClimateRemovalsProductsList'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Get Climate Products
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/products/{product}:
get:
description: <p>Retrieves the details of a Climate product with the given ID.</p>
operationId: getClimateProductsProduct
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- in: path
name: product
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
$ref: '#/components/schemas/GetClimateProductsProductRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.product'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Get Climate Products Product
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/reservations:
get:
description: >-
<p>Lists all Climate order objects. The orders are returned sorted by
creation date, with the
most recently created orders appearing first.</p>
operationId: getClimateReservations
parameters:
- description: >-
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.
in: query
name: ending_before
required: false
schema:
maxLength: 5000
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: >-
A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: >-
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.
in: query
name: starting_after
required: false
schema:
maxLength: 5000
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
$ref: '#/components/schemas/GetClimateReservationsRequest'
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
x-expandableFields:
- data
$ref: '#/components/schemas/ClimateRemovalsOrdersList'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Get Climate Reservations
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
post:
description: >-
<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>
operationId: postClimateReservations
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
beneficiary:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostClimateReservationsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.order'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Climate Reservations
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/reservations/{order}:
get:
description: >-
<p>Retrieves the details of a Climate order object with the given
ID.</p>
operationId: getClimateReservationsOrder
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: Unique identifier of the order.
in: path
name: order
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
$ref: '#/components/schemas/GetClimateReservationsOrderRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.order'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Get Climate Reservations Order
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
post:
description: >-
<p>Updates the specified order by setting the values of the parameters
passed.</p>
operationId: postClimateReservationsOrder
parameters:
- description: Unique identifier of the order.
in: path
name: order
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
beneficiary:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostClimateReservationsOrderRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.order'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Climate Reservations Order
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/reservations/{order}/cancel:
post:
description: >-
<p>Cancels a Climate order. You can cancel an order within 30 days 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>
operationId: postClimateReservationsOrderCancel
parameters:
- description: Unique identifier of the order.
in: path
name: order
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostClimateReservationsOrderCancelRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.order'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Climate Reservations Order Cancel
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/reservations/{order}/confirm:
post:
description: >-
<p>Confirms a Climate order. When you confirm your order, we immediately
deduct the funds from your
Stripe balance.</p>
operationId: postClimateReservationsOrderConfirm
parameters:
- description: Unique identifier of the order.
in: path
name: order
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostClimateReservationsOrderConfirmRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.order'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Climate Reservations Order Confirm
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/suppliers:
get:
description: <p>Lists all available Climate supplier objects.</p>
operationId: getClimateSuppliers
parameters:
- description: >-
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.
in: query
name: ending_before
required: false
schema:
maxLength: 5000
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: >-
A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: >-
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.
in: query
name: starting_after
required: false
schema:
maxLength: 5000
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
$ref: '#/components/schemas/GetClimateSuppliersRequest'
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
x-expandableFields:
- data
$ref: '#/components/schemas/ClimateRemovalsSuppliersList'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Get Climate Suppliers
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
/v1/climate/suppliers/{supplier}:
get:
description: <p>Retrieves a Climate supplier object.</p>
operationId: getClimateSuppliersSupplier
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- in: path
name: supplier
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
$ref: '#/components/schemas/GetClimateSuppliersSupplierRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/climate.supplier'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Get Climate Suppliers Supplier
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
tags:
- Climate
components:
schemas:
error:
description: An error response from the Stripe API
properties:
error:
$ref: '#/components/schemas/api_errors'
required:
- error
type: object
climate.order:
description: >-
Orders represent your intent to purchase a particular Climate product.
When you create an order, the
payment is deducted from your merchant balance.
properties:
amount_fees:
description: >-
Total amount of [Frontier](https://frontierclimate.com/)'s service
fees in the currency's smallest unit.
type: integer
amount_subtotal:
description: Total amount of the carbon removal in the currency's smallest unit.
type: integer
amount_total:
description: >-
Total amount of the order including fees in the currency's smallest
unit.
type: integer
beneficiary:
$ref: '#/components/schemas/climate_removals_beneficiary'
canceled_at:
description: >-
Time at which the order was canceled. Measured in seconds since the
Unix epoch.
format: unix-time
nullable: true
type: integer
cancellation_reason:
description: Reason for the cancellation of this order.
enum:
- expired
- product_unavailable
- requested
nullable: true
type: string
x-stripeBypassValidation: true
certificate:
description: For delivered orders, a URL to a delivery certificate for the order.
maxLength: 5000
nullable: true
type: string
confirmed_at:
description: >-
Time at which the order was confirmed. Measured in seconds since the
Unix epoch.
format: unix-time
nullable: true
type: integer
created:
description: >-
Time at which the object was created. Measured in seconds since the
Unix epoch.
format: unix-time
type: integer
currency:
description: >-
Three-letter [ISO currency
code](https://www.iso.org/iso-4217-currency-codes.html), in
lowercase, representing the currency for this order.
maxLength: 5000
type: string
delayed_at:
description: >-
Time at which the order's expected_delivery_year was delayed.
Measured in seconds since the Unix epoch.
format: unix-time
nullable: true
type: integer
delivered_at:
description: >-
Time at which the order was delivered. Measured in seconds since the
Unix epoch.
format: unix-time
nullable: true
type: integer
delivery_details:
description: Details about the delivery of carbon removal for this order.
items:
$ref: '#/components/schemas/climate_re
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-climate-api-openapi.yml