Package com.stripe.param

Class PriceCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.PriceCreateParams
public class PriceCreateParams extends ApiRequestParams

  • Method Details

    • builder

      public static PriceCreateParams.Builder builder()

    • getActive

      public Boolean getActive()
      Whether the price can be used for new purchases. Defaults to true.

    • getBillingScheme

      public PriceCreateParams.BillingScheme getBillingScheme()
      Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.

    • getCurrency

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

    • getCurrencyOptions

      public Map<String,PriceCreateParams.CurrencyOption> getCurrencyOptions()
      Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

    • getCustomUnitAmount

      public PriceCreateParams.CustomUnitAmount getCustomUnitAmount()
      When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

    • getLookupKey

      public String getLookupKey()
      A lookup key used to retrieve prices dynamically from a static string. This may be up to 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • getNickname

      public String getNickname()
      A brief description of the price, hidden from customers.

    • getProduct

      public String getProduct()
      The ID of the product that this price will belong to.

    • getProductData

      public PriceCreateParams.ProductData getProductData()
      These fields can be used to create a new product that this price will belong to.

    • getRecurring

      public PriceCreateParams.Recurring getRecurring()
      The recurring components of a price such as interval and usage_type.

    • getTaxBehavior

      public PriceCreateParams.TaxBehavior getTaxBehavior()
      Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

    • getTiers

      public List<PriceCreateParams.Tier> getTiers()
      Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

    • getTiersMode

      public PriceCreateParams.TiersMode getTiersMode()
      Defines if 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 pricing can successively change as the quantity grows.

    • getTransferLookupKey

      public Boolean getTransferLookupKey()
      If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.

    • getTransformQuantity

      public PriceCreateParams.TransformQuantity getTransformQuantity()
      Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers.

    • getUnitAmount

      public Long getUnitAmount()
      A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required, unless billing_scheme=tiered.

    • getUnitAmountDecimal

      public BigDecimal getUnitAmountDecimal()
      Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.