Package com.stripe.model.climate

Class Product

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.climate.Product
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class Product extends ApiResource implements HasId
A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.

  • Constructor Details

    • Product

      public Product()

  • Method Details

    • list

      public static ProductCollection list(Map<String,Object> params) throws StripeException
      Lists all available Climate product objects.
      Throws:
      StripeException

    • list

      public static ProductCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Lists all available Climate product objects.
      Throws:
      StripeException

    • list

      public static ProductCollection list(ProductListParams params) throws StripeException
      Lists all available Climate product objects.
      Throws:
      StripeException

    • list

      public static ProductCollection list(ProductListParams params, RequestOptions options) throws StripeException
      Lists all available Climate product objects.
      Throws:
      StripeException

    • retrieve

      public static Product retrieve(String product) throws StripeException
      Retrieves the details of a Climate product with the given ID.
      Throws:
      StripeException

    • retrieve

      public static Product retrieve(String product, RequestOptions options) throws StripeException
      Retrieves the details of a Climate product with the given ID.
      Throws:
      StripeException

    • retrieve

      public static Product retrieve(String product, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of a Climate product with the given ID.
      Throws:
      StripeException

    • retrieve

      public static Product retrieve(String product, ProductRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of a Climate product with the given ID.
      Throws:
      StripeException

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCurrentPricesPerMetricTon

      public Map<String,Product.CurrentPricesPerMetricTon> getCurrentPricesPerMetricTon()
      Current prices for a metric ton of carbon removal in a currency's smallest unit.

    • getDeliveryYear

      public Long getDeliveryYear()
      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.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getMetricTonsAvailable

      public BigDecimal getMetricTonsAvailable()
      The quantity of metric tons available for reservation.

    • getName

      public String getName()
      The Climate product's name.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to climate.product.

    • getSuppliers

      public List<Supplier> getSuppliers()
      The carbon removal suppliers that fulfill orders for this Climate product.

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCurrentPricesPerMetricTon

      public void setCurrentPricesPerMetricTon(Map<String,Product.CurrentPricesPerMetricTon> currentPricesPerMetricTon)
      Current prices for a metric ton of carbon removal in a currency's smallest unit.

    • setDeliveryYear

      public void setDeliveryYear(Long deliveryYear)
      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.

    • setId

      public void setId(String 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.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetricTonsAvailable

      public void setMetricTonsAvailable(BigDecimal metricTonsAvailable)
      The quantity of metric tons available for reservation.

    • setName

      public void setName(String name)
      The Climate product's name.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to climate.product.

    • setSuppliers

      public void setSuppliers(List<Supplier> suppliers)
      The carbon removal suppliers that fulfill orders for this Climate product.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      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.
      Specified by:
      getId in interface HasId