Package com.stripe.model.v2.billing

Class LicenseFee

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

  • Constructor Details

    • LicenseFee

      public LicenseFee()

  • Method Details

    • getActive

      public Boolean getActive()
      Whether this License Fee is active. Inactive License Fees cannot be used in new activations or be modified.

    • 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 license fee. 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 the license fee's most recently created version.

    • getLicensedItem

      public LicensedItem getLicensedItem()
      The Licensed Item that this License Fee binds to.

    • getLiveVersion

      public String getLiveVersion()
      The ID of the License Fee 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 License Fee. 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.license_fee.

    • getServiceInterval

      public String getServiceInterval()
      The interval for assessing service.

      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 license fee is inclusive or exclusive of tax.

      One of exclusive, or inclusive.

    • 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<LicenseFee.Tier> getTiers()
      Each element represents a pricing tier. Cannot be set if unit_amount is provided.

    • getTransformQuantity

      public LicenseFee.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.

    • setActive

      public void setActive(Boolean active)
      Whether this License Fee is active. Inactive License Fees cannot be used in new activations or be modified.

    • 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 license fee. 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 the license fee's most recently created version.

    • setLicensedItem

      public void setLicensedItem(LicensedItem licensedItem)
      The Licensed Item that this License Fee binds to.

    • setLiveVersion

      public void setLiveVersion(String liveVersion)
      The ID of the License Fee 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 License Fee. 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.license_fee.

    • setServiceInterval

      public void setServiceInterval(String serviceInterval)
      The interval for assessing service.

      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 license fee is inclusive or exclusive of tax.

      One of exclusive, or inclusive.

    • 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<LicenseFee.Tier> tiers)
      Each element represents a pricing tier. Cannot be set if unit_amount is provided.

    • setTransformQuantity

      public void setTransformQuantity(LicenseFee.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