View Source Stripe.Climate.Product (stripity_stripe v3.2.0)

A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.

Summary

Types

t()

The climate.product type.

Functions

list(params \\ %{}, opts \\ [])

Lists all available Climate product objects.

retrieve(product, params \\ %{}, opts \\ [])

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

Types

t()

@type t() :: %Stripe.Climate.Product{
  created: integer(),
  current_prices_per_metric_ton: term(),
  delivery_year: integer() | nil,
  id: binary(),
  livemode: boolean(),
  metric_tons_available: binary(),
  name: binary(),
  object: binary(),
  suppliers: term()
}

The climate.product type.

created Time at which the object was created. Measured in seconds since the Unix epoch.
current_prices_per_metric_ton Current prices for a metric ton of carbon removal in a currency's smallest unit.
delivery_year The year in which the carbon removal is expected to be delivered.
id 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.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metric_tons_available The quantity of metric tons available for reservation.
name The Climate product's name.
object String representing the object's type. Objects of the same type share the same value.
suppliers The carbon removal suppliers that fulfill orders for this Climate product.

Functions

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Lists all available Climate product objects.

Details

Method: get
Path: /v1/climate/products

retrieve(product, params \\ %{}, opts \\ [])

@spec retrieve(
  product :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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

Details

Method: get
Path: /v1/climate/products/{product}