Stripe: List suppliers

← Climate operations · Get started

Operation stripe.getclimatesuppliers

Provider route: GET /v1/climate/suppliers. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["climate"]["getClimateSuppliers"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.climate.getClimateSuppliers(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.climate.get_climate_suppliers(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.ending_before	string	Optional	Maximum length: 5000
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.limit	integer	Optional
query.starting_after	string	Optional	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent
data[]	Model	Each item	Expand Retrieve a supplier — response body
has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
object	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Always has the value `list`. Known values: list
url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/climate/suppliers

Referenced models: Retrieve a supplier — response body

Schemas

Retrieve a supplier — response body

Field	Type	Presence	Description and constraints
$	object	Root	A supplier of carbon removal.
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
info_url	string	Required within parent	Link to a webpage to learn more about the supplier. Maximum length: 5000
livemode	boolean	Required within parent	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
locations	array	Required within parent	The locations in which this supplier operates.
locations[]	Model	Each item	Expand Retrieve a supplier — response body — locations item
name	string	Required within parent	Name of this carbon removal supplier. Maximum length: 5000
object	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Known values: climate.supplier
removal_pathway	string	Required within parent	The scientific pathway used for carbon removal. Known values: biomass_carbon_removal_and_storage, direct_air_capture, enhanced_weathering, marine_carbon_removal

Referenced models: Retrieve a supplier — response body — locations item

Retrieve a supplier — response body — locations item

Field	Type	Presence	Description and constraints
$	object	Root
city	JSON	Optional
city (anyOf 1)	string	Alternative	The city where the supplier is located. Maximum length: 5000
city (anyOf 2)	null	Alternative
country	string	Required within parent	Two-letter ISO code representing the country where the supplier is located. Maximum length: 5000
latitude	JSON	Optional
latitude (anyOf 1)	JSON	Alternative
latitude (anyOf 1) (anyOf 1)	number	Alternative	The geographic latitude where the supplier is located.
latitude (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
latitude (anyOf 2)	null	Alternative
longitude	JSON	Optional
longitude (anyOf 1)	JSON	Alternative
longitude (anyOf 1) (anyOf 1)	number	Alternative	The geographic longitude where the supplier is located.
longitude (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
longitude (anyOf 2)	null	Alternative
region	JSON	Optional
region (anyOf 1)	string	Alternative	The state/county/province/region where the supplier is located. Maximum length: 5000
region (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: stripe.getclimatesuppliers. Catalog operation: GetClimateSuppliers. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source