Class RateCardRate

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

public class RateCardRate extends StripeObject implements HasId
  • Constructor Details

    • RateCardRate

      public RateCardRate()
  • Method Details

    • getCreated

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

      public RateCardRate.CustomPricingUnitAmount getCustomPricingUnitAmount()
      The custom pricing unit that this rate binds 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.
    • getMeteredItem

      public MeteredItem getMeteredItem()
      The Metered Item that this rate binds to.
    • 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_rate.

    • getRateCard

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

      public String getRateCardVersion()
      The ID of the Rate Card Version it was created on.
    • getTieringMode

      public String getTieringMode()
      Defines whether the tiering price should be graduated or volume-based. In volume-based tiering, the maximum quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity grows into new tiers. Can only be set if tiers is set.

      One of graduated, or volume.

    • getTiers

      public List<RateCardRate.Tier> getTiers()
      Each element represents a pricing tier. Cannot be set if unit_amount is provided.
    • getTransformQuantity

      public RateCardRate.TransformQuantity getTransformQuantity()
      Apply a transformation to the reported usage or set quantity before computing the amount billed.
    • getUnitAmount

      public String getUnitAmount()
      The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal places. Cannot be set if tiers is provided.
    • setCreated

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

      public void setCustomPricingUnitAmount(RateCardRate.CustomPricingUnitAmount customPricingUnitAmount)
      The custom pricing unit that this rate binds 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.
    • setMeteredItem

      public void setMeteredItem(MeteredItem meteredItem)
      The Metered Item that this rate binds to.
    • 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_rate.

    • setRateCard

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

      public void setRateCardVersion(String rateCardVersion)
      The ID of the Rate Card Version it was created on.
    • setTieringMode

      public void setTieringMode(String tieringMode)
      Defines whether the tiering price should be graduated or volume-based. In volume-based tiering, the maximum quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity grows into new tiers. Can only be set if tiers is set.

      One of graduated, or volume.

    • setTiers

      public void setTiers(List<RateCardRate.Tier> tiers)
      Each element represents a pricing tier. Cannot be set if unit_amount is provided.
    • setTransformQuantity

      public void setTransformQuantity(RateCardRate.TransformQuantity transformQuantity)
      Apply a transformation to the reported usage or set quantity before computing the amount billed.
    • setUnitAmount

      public void setUnitAmount(String unitAmount)
      The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal places. Cannot be set if tiers is provided.
    • 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