Price (stripe-java 19.45.0 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.ApiResource
  - - com.stripe.model.Price

All Implemented Interfaces:: HasId, MetadataStore<Price>, StripeObjectInterface

public class Price
extends ApiResource
implements HasId, MetadataStore<Price>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Price.Recurring

static class Price.Tier

static class Price.TransformQuantity
- Nested classes/interfaces inherited from class com.stripe.net.ApiResource
  ApiResource.RequestMethod

Nested Classes
Modifier and Type	Class and Description
`static class`	`Price.Recurring`
`static class`	`Price.Tier`
`static class`	`Price.TransformQuantity`

Field Summary
- Fields inherited from class com.stripe.net.ApiResource
  CHARSET, GSON
- Fields inherited from class com.stripe.model.StripeObject
  PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

Price()

Constructors
Constructor and Description
`Price()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`static Price`	`create(java.util.Map<java.lang.String,java.lang.Object> params)` Creates a new price for an existing product.
`static Price`	`create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Creates a new price for an existing product.
`static Price`	`create(PriceCreateParams params)` Creates a new price for an existing product.
`static Price`	`create(PriceCreateParams params, RequestOptions options)` Creates a new price for an existing product.
`boolean`	`equals(java.lang.Object o)`
`java.lang.Boolean`	`getActive()` Whether the price can be used for new purchases.
`java.lang.String`	`getBillingScheme()` Describes how to compute the price per period.
`java.lang.Long`	`getCreated()` Time at which the object was created.
`java.lang.String`	`getCurrency()` Three-letter ISO currency code, in lowercase.
`java.lang.Boolean`	`getDeleted()` Always true for a deleted object.
`java.lang.String`	`getId()` Unique identifier for the object.
`java.lang.Boolean`	`getLivemode()` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`java.lang.String`	`getLookupKey()` A lookup key used to retrieve prices dynamically from a static string.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Set of key-value pairs that you can attach to an object.
`java.lang.String`	`getNickname()` A brief description of the plan, hidden from customers.
`java.lang.String`	`getObject()` String representing the object's type.
`java.lang.String`	`getProduct()` Get ID of expandable `product` object.
`Product`	`getProductObject()` Get expanded `product`.
`Price.Recurring`	`getRecurring()` The recurring components of a price such as `interval` and `usage_type`.
`java.util.List<Price.Tier>`	`getTiers()` Each element represents a pricing tier.
`java.lang.String`	`getTiersMode()` Defines if the tiering price should be `graduated` or `volume` based.
`Price.TransformQuantity`	`getTransformQuantity()` Apply a transformation to the reported usage or set quantity before computing the amount billed.
`java.lang.String`	`getType()` One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
`java.lang.Long`	`getUnitAmount()` The unit amount in %s to be charged, represented as a whole integer if possible.
`java.math.BigDecimal`	`getUnitAmountDecimal()` The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places.
`int`	`hashCode()`
`static PriceCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params)` Returns a list of your prices.
`static PriceCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Returns a list of your prices.
`static PriceCollection`	`list(PriceListParams params)` Returns a list of your prices.
`static PriceCollection`	`list(PriceListParams params, RequestOptions options)` Returns a list of your prices.
`static Price`	`retrieve(java.lang.String price)` Retrieves the price with the given ID.
`static Price`	`retrieve(java.lang.String price, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Retrieves the price with the given ID.
`static Price`	`retrieve(java.lang.String price, PriceRetrieveParams params, RequestOptions options)` Retrieves the price with the given ID.
`static Price`	`retrieve(java.lang.String price, RequestOptions options)` Retrieves the price with the given ID.
`void`	`setActive(java.lang.Boolean active)` Whether the price can be used for new purchases.
`void`	`setBillingScheme(java.lang.String billingScheme)` Describes how to compute the price per period.
`void`	`setCreated(java.lang.Long created)` Time at which the object was created.
`void`	`setCurrency(java.lang.String currency)` Three-letter ISO currency code, in lowercase.
`void`	`setDeleted(java.lang.Boolean deleted)` Always true for a deleted object.
`void`	`setId(java.lang.String id)` Unique identifier for the object.
`void`	`setLivemode(java.lang.Boolean livemode)` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`void`	`setLookupKey(java.lang.String lookupKey)` A lookup key used to retrieve prices dynamically from a static string.
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)` Set of key-value pairs that you can attach to an object.
`void`	`setNickname(java.lang.String nickname)` A brief description of the plan, hidden from customers.
`void`	`setObject(java.lang.String object)` String representing the object's type.
`void`	`setProduct(java.lang.String id)`
`void`	`setProductObject(Product expandableObject)`
`void`	`setRecurring(Price.Recurring recurring)` The recurring components of a price such as `interval` and `usage_type`.
`void`	`setTiers(java.util.List<Price.Tier> tiers)` Each element represents a pricing tier.
`void`	`setTiersMode(java.lang.String tiersMode)` Defines if the tiering price should be `graduated` or `volume` based.
`void`	`setTransformQuantity(Price.TransformQuantity transformQuantity)` Apply a transformation to the reported usage or set quantity before computing the amount billed.
`void`	`setType(java.lang.String type)` One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
`void`	`setUnitAmount(java.lang.Long unitAmount)` The unit amount in %s to be charged, represented as a whole integer if possible.
`void`	`setUnitAmountDecimal(java.math.BigDecimal unitAmountDecimal)` The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places.
`Price`	`update(java.util.Map<java.lang.String,java.lang.Object> params)` Updates the specified price by setting the values of the parameters passed.
`Price`	`update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Updates the specified price by setting the values of the parameters passed.
`Price`	`update(PriceUpdateParams params)` Updates the specified price by setting the values of the parameters passed.
`Price`	`update(PriceUpdateParams params, RequestOptions options)` Updates the specified price by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Price
```
public Price()
```
- Method Detail
  - getProduct
```
public java.lang.String getProduct()
```
    Get ID of expandable product object.
  - setProduct
```
public void setProduct(java.lang.String id)
```
  - getProductObject
```
public Product getProductObject()
```
    Get expanded product.
  - setProductObject
```
public void setProductObject(Product expandableObject)
```
  - list
```
public static PriceCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                            throws StripeException
```
    Returns a list of your prices.
    
    Throws:
    
    StripeException
  - list
```
public static PriceCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                   RequestOptions options)
                            throws StripeException
```
    Returns a list of your prices.
    
    Throws:
    
    StripeException
  - list
```
public static PriceCollection list(PriceListParams params)
                            throws StripeException
```
    Returns a list of your prices.
    
    Throws:
    
    StripeException
  - list
```
public static PriceCollection list(PriceListParams params,
                                   RequestOptions options)
                            throws StripeException
```
    Returns a list of your prices.
    
    Throws:
    
    StripeException
  - create
```
public static Price create(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws StripeException
```
    Creates a new price for an existing product. The price can be recurring or one-time.
    
    Throws:
    
    StripeException
  - create
```
public static Price create(java.util.Map<java.lang.String,java.lang.Object> params,
                           RequestOptions options)
                    throws StripeException
```
    Creates a new price for an existing product. The price can be recurring or one-time.
    
    Throws:
    
    StripeException
  - create
```
public static Price create(PriceCreateParams params)
                    throws StripeException
```
    Creates a new price for an existing product. The price can be recurring or one-time.
    
    Throws:
    
    StripeException
  - create
```
public static Price create(PriceCreateParams params,
                           RequestOptions options)
                    throws StripeException
```
    Creates a new price for an existing product. The price can be recurring or one-time.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Price retrieve(java.lang.String price)
                      throws StripeException
```
    Retrieves the price with the given ID.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Price retrieve(java.lang.String price,
                             RequestOptions options)
                      throws StripeException
```
    Retrieves the price with the given ID.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Price retrieve(java.lang.String price,
                             java.util.Map<java.lang.String,java.lang.Object> params,
                             RequestOptions options)
                      throws StripeException
```
    Retrieves the price with the given ID.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Price retrieve(java.lang.String price,
                             PriceRetrieveParams params,
                             RequestOptions options)
                      throws StripeException
```
    Retrieves the price with the given ID.
    
    Throws:
    
    StripeException
  - update
```
public Price update(java.util.Map<java.lang.String,java.lang.Object> params)
             throws StripeException
```
    Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
    
    Specified by:
    
    update in interface MetadataStore<Price>
    
    Throws:
    
    StripeException
  - update
```
public Price update(java.util.Map<java.lang.String,java.lang.Object> params,
                    RequestOptions options)
             throws StripeException
```
    Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
    
    Specified by:
    
    update in interface MetadataStore<Price>
    
    Throws:
    
    StripeException
  - update
```
public Price update(PriceUpdateParams params)
             throws StripeException
```
    Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
    
    Throws:
    
    StripeException
  - update
```
public Price update(PriceUpdateParams params,
                    RequestOptions options)
             throws StripeException
```
    Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
    
    Throws:
    
    StripeException
  - getActive
```
public java.lang.Boolean getActive()
```
    Whether the price can be used for new purchases.
  - getBillingScheme
```
public java.lang.String 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.
    One of per_unit, or tiered.
  - getCreated
```
public java.lang.Long getCreated()
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - getCurrency
```
public java.lang.String getCurrency()
```
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
  - getDeleted
```
public java.lang.Boolean getDeleted()
```
    Always true for a deleted object.
  - getLivemode
```
public java.lang.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 java.lang.String getLookupKey()
```
    A lookup key used to retrieve prices dynamically from a static string.
  - getNickname
```
public java.lang.String getNickname()
```
    A brief description of the plan, hidden from customers.
  - getObject
```
public java.lang.String getObject()
```
    String representing the object's type. Objects of the same type share the same value.
    Equal to price.
  - getRecurring
```
public Price.Recurring getRecurring()
```
    The recurring components of a price such as interval and usage_type.
  - getTiers
```
public java.util.List<Price.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 java.lang.String 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 change as the quantity grows.
    One of graduated, or volume.
  - getTransformQuantity
```
public Price.TransformQuantity getTransformQuantity()
```
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
  - getType
```
public java.lang.String getType()
```
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
  - getUnitAmount
```
public java.lang.Long getUnitAmount()
```
    The unit amount in %s to be charged, represented as a whole integer if possible.
  - getUnitAmountDecimal
```
public java.math.BigDecimal getUnitAmountDecimal()
```
    The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places.
  - setActive
```
public void setActive(java.lang.Boolean active)
```
    Whether the price can be used for new purchases.
  - setBillingScheme
```
public void setBillingScheme(java.lang.String billingScheme)
```
    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.
    One of per_unit, or tiered.
  - setCreated
```
public void setCreated(java.lang.Long created)
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - setCurrency
```
public void setCurrency(java.lang.String currency)
```
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
  - setDeleted
```
public void setDeleted(java.lang.Boolean deleted)
```
    Always true for a deleted object.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier for the object.
  - setLivemode
```
public void setLivemode(java.lang.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(java.lang.String lookupKey)
```
    A lookup key used to retrieve prices dynamically from a static string.
  - setMetadata
```
public void setMetadata(java.util.Map<java.lang.String,java.lang.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.
  - setNickname
```
public void setNickname(java.lang.String nickname)
```
    A brief description of the plan, hidden from customers.
  - setObject
```
public void setObject(java.lang.String object)
```
    String representing the object's type. Objects of the same type share the same value.
    Equal to price.
  - setRecurring
```
public void setRecurring(Price.Recurring recurring)
```
    The recurring components of a price such as interval and usage_type.
  - setTiers
```
public void setTiers(java.util.List<Price.Tier> tiers)
```
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
  - setTiersMode
```
public void setTiersMode(java.lang.String tiersMode)
```
    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 change as the quantity grows.
    One of graduated, or volume.
  - setTransformQuantity
```
public void setTransformQuantity(Price.TransformQuantity transformQuantity)
```
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
  - setType
```
public void setType(java.lang.String type)
```
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
  - setUnitAmount
```
public void setUnitAmount(java.lang.Long unitAmount)
```
    The unit amount in %s to be charged, represented as a whole integer if possible.
  - setUnitAmountDecimal
```
public void setUnitAmountDecimal(java.math.BigDecimal unitAmountDecimal)
```
    The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getId
```
public java.lang.String getId()
```
    Unique identifier for the object.
    
    Specified by:
    
    getId in interface HasId
  - getMetadata
```
public java.util.Map<java.lang.String,java.lang.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.
    
    Specified by:
    
    getMetadata in interface MetadataStore<Price>

Class Price

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

Field Summary

Fields inherited from class com.stripe.net.ApiResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.ApiResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

Price

Method Detail

getProduct

setProduct

getProductObject

setProductObject

list

list

list

list

create

create

create

create

retrieve

retrieve

retrieve

retrieve

update

update

update

update

getActive

getBillingScheme

getCreated

getCurrency

getDeleted

getLivemode

getLookupKey

getNickname

getObject

getRecurring

getTiers

getTiersMode

getTransformQuantity

getType

getUnitAmount

getUnitAmountDecimal

setActive

setBillingScheme

setCreated

setCurrency

setDeleted

setId

setLivemode

setLookupKey

setMetadata

setNickname

setObject

setRecurring

setTiers

setTiersMode

setTransformQuantity

setType

setUnitAmount

setUnitAmountDecimal

equals

canEqual

hashCode

getId

getMetadata