Class RateCardCustomPricingUnitOverageRate

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.billing.RateCardCustomPricingUnitOverageRate
All Implemented Interfaces:
HasId, StripeObjectInterface

public class RateCardCustomPricingUnitOverageRate extends StripeObject implements HasId
A rate card custom pricing unit overage rate defines the conversion rate from a custom pricing unit to fiat currency when credits are exhausted. This enables automatic overage charges at a configurable per-unit rate.
  • Constructor Details

    • RateCardCustomPricingUnitOverageRate

      public RateCardCustomPricingUnitOverageRate()
  • Method Details

    • getCreated

      public Instant getCreated()
      Timestamp of when the object was created.
    • getCustomPricingUnit

      public String getCustomPricingUnit()
      The ID of the custom pricing unit this overage rate applies to.
    • 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.
    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    • getObject

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

      Equal to v2.billing.rate_card_custom_pricing_unit_overage_rate.

    • getOneTimeItem

      public OneTimeItem getOneTimeItem()
      A one-time item represents a product that can be charged as a one-time line item, used for overage charges when custom pricing unit credits are exhausted.
    • getRateCard

      public String getRateCard()
      The ID of the Rate Card this overage rate belongs to.
    • getRateCardVersion

      public String getRateCardVersion()
      The ID of the Rate Card Version this overage rate was created on.
    • getUnitAmount

      public String getUnitAmount()
      The per-unit amount to charge for overages, represented as a decimal string in minor currency units with at most 12 decimal places.
    • setCreated

      public void setCreated(Instant created)
      Timestamp of when the object was created.
    • setCustomPricingUnit

      public void setCustomPricingUnit(String customPricingUnit)
      The ID of the custom pricing unit this overage rate applies to.
    • setId

      public void setId(String id)
      Unique identifier for the object.
    • 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.
    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    • setObject

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

      Equal to v2.billing.rate_card_custom_pricing_unit_overage_rate.

    • setOneTimeItem

      public void setOneTimeItem(OneTimeItem oneTimeItem)
      A one-time item represents a product that can be charged as a one-time line item, used for overage charges when custom pricing unit credits are exhausted.
    • setRateCard

      public void setRateCard(String rateCard)
      The ID of the Rate Card this overage rate belongs to.
    • setRateCardVersion

      public void setRateCardVersion(String rateCardVersion)
      The ID of the Rate Card Version this overage rate was created on.
    • setUnitAmount

      public void setUnitAmount(String unitAmount)
      The per-unit amount to charge for overages, represented as a decimal string in minor currency units with at most 12 decimal places.
    • 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.
      Specified by:
      getId in interface HasId