List all bundle portfolios
HTTPGET
to /v1/bundle-portfolios
Response
array
object
A curated group of predefined project bundles., e.g., Oxford Offsetting Principles.
Project bundles for a particular Bundle portfolio may change over time.
idstringrequired
Bundle portfolio unique identifier.
identifierstringrequired
Identifier of the bundle portfolio.
labelstringrequired
Human readable name of the bundle portfolio.
bundle_selectionarrayrequired
A Bundle Selection represents an account's default project bundle ratios that are used when an order is placed without specifying project bundles.
An account initial project bundle selection is
- Conserving forests in Asia - 95%
- Ocean Carbon Removal - 5%
object
Maps a bundle's unique identifier to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOfrequiredSelection percentage as integer
Selection percentage as integer
Errors
This API operation can return the following errors:401
429
Update an account's bundle portfolio
HTTPPUT
to /v1/bundle-portfolios
Request body
bundle_portfolio_idstringrequired
Response
A curated group of predefined project bundles., e.g., Oxford Offsetting Principles.
Project bundles for a particular Bundle portfolio may change over time.
idstringrequired
Bundle portfolio unique identifier.
identifierstringrequired
Identifier of the bundle portfolio.
labelstringrequired
Human readable name of the bundle portfolio.
bundle_selectionarrayrequired
A Bundle Selection represents an account's default project bundle ratios that are used when an order is placed without specifying project bundles.
An account initial project bundle selection is
- Conserving forests in Asia - 95%
- Ocean Carbon Removal - 5%
object
Maps a bundle's unique identifier to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOfrequiredSelection percentage as integer
Selection percentage as integer
Errors
This API operation can return the following errors:400
api_version_invalid
400
bundle_selection_ratios_invalid
400
bundle_selection_bundle_invalid
400
order_value_invalid
400
bundle_id_invalid
400
id_invalid
400
distance_invalid
400
test_account_name_update_disallowed
400
bundle_selection_ratios_invalid_format
400
address_not_found