Climate Supplier

A supplier of carbon removal.

The Climate supplier object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

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

  • info_urlstring

    Link to a webpage to learn more about the supplier.

  • livemodeboolean

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

  • locationsarray of objects

    The locations in which this supplier operates.

  • namestring

    Name of this carbon removal supplier.

  • removal_pathwayenum

    The scientific pathway used for carbon removal.

    Possible enum values
    biomass_carbon_removal_and_storage

    Biomass carbon removal and storage

    direct_air_capture

    Direct air capture

    enhanced_weathering

    Enhanced weathering

The Climate supplier object
{
"id": "climsup_charm_industrial",
"object": "climate.supplier",
"info_url": "https://frontierclimate.com/portfolio/charm-industrial",
"livemode": false,
"locations": [
{
"city": "San Francisco",
"country": "US",
"latitude": 37.7749,
"longitude": -122.4194,
"region": "CA"
}
],
"name": "Charm Industrial",
"removal_pathway": "biomass_carbon_removal_and_storage"
}

Retrieve a supplier

Retrieves a Climate supplier object.

Parameters

No parameters.

Returns

A Climate supplier object.

GET /v1/climate/suppliers/:id
curl https://api.stripe.com/v1/climate/suppliers/climsup_charm_industrial \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "climsup_charm_industrial",
"object": "climate.supplier",
"info_url": "https://frontierclimate.com/portfolio/charm-industrial",
"livemode": false,
"locations": [
{
"city": "San Francisco",
"country": "US",
"latitude": 37.7749,
"longitude": -122.4194,
"region": "CA"
}
],
"name": "Charm Industrial",
"removal_pathway": "biomass_carbon_removal_and_storage"
}

List suppliers

Lists all available Climate supplier objects.

Parameters

No parameters.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit suppliers, starting after supplier starting_after. Each entry in the array is a separate supplier object. If no more suppliers are available, the resulting array is empty.

GET /v1/climate/suppliers
curl -G https://api.stripe.com/v1/climate/suppliers \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d limit=3
Response
{
"object": "list",
"url": "/v1/climate/suppliers",
"has_more": false,
"data": [
{
"id": "climsup_charm_industrial",
"object": "climate.supplier",
"info_url": "https://frontierclimate.com/portfolio/charm-industrial",
"livemode": false,
"locations": [
{
"city": "San Francisco",
"country": "US",
"latitude": 37.7749,
"longitude": -122.4194,
"region": "CA"
}
],
"name": "Charm Industrial",
"removal_pathway": "biomass_carbon_removal_and_storage"
}
{...}
{...}
],
}

Forwarding RequestPreview feature

Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request.

Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period.

You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request.

Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits.

Related guide: Forward card details to third-party API endpoints.

Webhook Endpoints

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

Related guide: Setting up webhooks

Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$