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

A supplier of carbon removal.

Summary

Types

t()

The climate.supplier type.

Functions

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

Lists all available Climate supplier objects.

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

Retrieves a Climate supplier object.

Types

t()

@type t() :: %Stripe.Climate.Supplier{
  id: binary(),
  info_url: binary(),
  livemode: boolean(),
  locations: term(),
  name: binary(),
  object: binary(),
  removal_pathway: binary()
}

The climate.supplier type.

id Unique identifier for the object.
info_url Link to a webpage to learn more about the supplier.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
locations The locations in which this supplier operates.
name Name of this carbon removal supplier.
object String representing the object’s type. Objects of the same type share the same value.
removal_pathway The scientific pathway used for carbon removal.

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 supplier objects.

Details

Method: get
Path: /v1/climate/suppliers

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

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

Retrieves a Climate supplier object.

Details

Method: get
Path: /v1/climate/suppliers/{supplier}