Get an account's bundle selection
HTTPGET
to /v1/bundle-selections
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
percentageoneOfrequiredSelection percentage as integer
Selection percentage as integer
Errors
This API operation can return the following errors:401
429
Update an account's bundle selection
HTTPPUT
to /v1/bundle-selections
Request 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
percentageoneOfSelection percentage as integer
Selection percentage as integer
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
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