Bundle selections
Get an account's bundle selection
GET to /v1/bundle-selectionsResponse
array
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
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%
Maps a bundle's unique identifier to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOfrequired
Errors
This API operation can return the following errors:401429Update an account's bundle selection
PUT to /v1/bundle-selectionsRequest body
array
Bundle selection percentages.
The sum of all percentages must equal 100.
If not specified, the preconfigured allocation ratios are going to be used.
If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.
object
Bundle selection percentages.
The sum of all percentages must equal 100.
If not specified, the preconfigured allocation ratios are going to be used.
If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.
Maps a bundle id to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOf
Response
array
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
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%
Maps a bundle's unique identifier to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOfrequired
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_found