Package com.stripe.model.v2.billing

Class RateCard

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.billing.RateCard
All Implemented Interfaces:
HasId, StripeObjectInterface
public class RateCard extends StripeObject implements HasId

  • Constructor Details

    • RateCard

      public RateCard()

  • Method Details

    • getActive

      public Boolean getActive()
      Whether this RateCard is active. Inactive RateCards cannot be used in new activations or have new rates added.

    • getCreated

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

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getDisplayName

      public String getDisplayName()
      A customer-facing name for the Rate Card. This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices. Maximum length of 250 characters.

    • getLatestVersion

      public String getLatestVersion()
      The ID of this rate card's most recently created version.

    • getLiveVersion

      public String getLiveVersion()
      The ID of the Rate Card Version that will be used by all subscriptions when no specific version is specified.

    • 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.

    • getLookupKey

      public String getLookupKey()
      An internal key you can use to search for a particular RateCard. Maximum length of 200 characters.

    • 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.

    • getServiceInterval

      public String getServiceInterval()
      The interval for assessing service. For example, a monthly Rate Card with a rate of $1 for the first 10 "workloads" and $2 thereafter means "$1 per workload up to 10 workloads during a month of service." This is similar to but distinct from billing interval; the service interval deals with the rate at which the customer accumulates fees, while the billing interval in Cadence deals with the rate the customer is billed.

      One of day, month, week, or year.

    • getServiceIntervalCount

      public Integer getServiceIntervalCount()
      The length of the interval for assessing service. For example, set this to 3 and service_interval to "month" in order to specify quarterly service.

    • getTaxBehavior

      public String getTaxBehavior()
      The Stripe Tax tax behavior - whether the rates are inclusive or exclusive of tax.

      One of exclusive, or inclusive.

    • setActive

      public void setActive(Boolean active)
      Whether this RateCard is active. Inactive RateCards cannot be used in new activations or have new rates added.

    • setCreated

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

    • setCurrency

      public void setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setDisplayName

      public void setDisplayName(String displayName)
      A customer-facing name for the Rate Card. This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices. Maximum length of 250 characters.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLatestVersion

      public void setLatestVersion(String latestVersion)
      The ID of this rate card's most recently created version.

    • setLiveVersion

      public void setLiveVersion(String liveVersion)
      The ID of the Rate Card Version that will be used by all subscriptions when no specific version is specified.

    • 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.

    • setLookupKey

      public void setLookupKey(String lookupKey)
      An internal key you can use to search for a particular RateCard. Maximum length of 200 characters.

    • 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.

    • setServiceInterval

      public void setServiceInterval(String serviceInterval)
      The interval for assessing service. For example, a monthly Rate Card with a rate of $1 for the first 10 "workloads" and $2 thereafter means "$1 per workload up to 10 workloads during a month of service." This is similar to but distinct from billing interval; the service interval deals with the rate at which the customer accumulates fees, while the billing interval in Cadence deals with the rate the customer is billed.

      One of day, month, week, or year.

    • setServiceIntervalCount

      public void setServiceIntervalCount(Integer serviceIntervalCount)
      The length of the interval for assessing service. For example, set this to 3 and service_interval to "month" in order to specify quarterly service.

    • setTaxBehavior

      public void setTaxBehavior(String taxBehavior)
      The Stripe Tax tax behavior - whether the rates are inclusive or exclusive of tax.

      One of exclusive, or inclusive.

    • 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