Retrieve a product

Changed on

Retrieves the details of a Climate product with the given ID.

get/v1/climate/products/{product}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/climate/products/{product}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

productstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

current_prices_per_metric_tonobject required

Current prices for a metric ton of carbon removal in a currency's smallest unit.

delivery_yearinteger nullable

The year in which the carbon removal is expected to be delivered. If the year is in the past, this represents spot inventory with guaranteed delivery.

idstring required

Unique identifier for the object. For convenience, Climate product IDs are human-readable strings that start with climsku_. See carbon removal inventory for a list of available carbon removal products.

livemodeboolean required

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

metric_tons_availablestring decimal required

The quantity of metric tons available for reservation.

namestring required

The Climate product's name.

object'climate.product' required

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

Changes

  • 8b5c2f03d4cdRevision changes
    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    This list may be incomplete.

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.