Package com.stripe.service

Class PriceService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.PriceService

public final class PriceService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
PriceService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Price	create(PriceCreateParams params)	Creates a new price for an existing product.
Price	create(PriceCreateParams params, RequestOptions options)	Creates a new price for an existing product.
StripeCollection<Price>	list()	Returns a list of your active prices, excluding inline prices.
StripeCollection<Price>	list(RequestOptions options)	Returns a list of your active prices, excluding inline prices.
StripeCollection<Price>	list(PriceListParams params)	Returns a list of your active prices, excluding inline prices.
StripeCollection<Price>	list(PriceListParams params, RequestOptions options)	Returns a list of your active prices, excluding inline prices.
Price	retrieve(String price)	Retrieves the price with the given ID.
Price	retrieve(String price, RequestOptions options)	Retrieves the price with the given ID.
Price	retrieve(String price, PriceRetrieveParams params)	Retrieves the price with the given ID.
Price	retrieve(String price, PriceRetrieveParams params, RequestOptions options)	Retrieves the price with the given ID.
StripeSearchResult<Price>	search(PriceSearchParams params)	Search for prices you’ve previously created using Stripe’s Search Query Language.
StripeSearchResult<Price>	search(PriceSearchParams params, RequestOptions options)	Search for prices you’ve previously created using Stripe’s Search Query Language.
Price	update(String price)	Updates the specified price by setting the values of the parameters passed.
Price	update(String price, RequestOptions options)	Updates the specified price by setting the values of the parameters passed.
Price	update(String price, PriceUpdateParams params)	Updates the specified price by setting the values of the parameters passed.
Price	update(String price, PriceUpdateParams params, RequestOptions options)	Updates the specified price by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PriceService

public PriceService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<Price> list(PriceListParams params)
                             throws StripeException

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

Throws:

StripeException

list

public StripeCollection<Price> list(RequestOptions options)
                             throws StripeException

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

Throws:

StripeException

list

public StripeCollection<Price> list()
                             throws StripeException

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

Throws:

StripeException

list

public StripeCollection<Price> list(PriceListParams params,
 RequestOptions options)
                             throws StripeException

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

Throws:

StripeException

create

public 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 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 Price retrieve(String price,
 PriceRetrieveParams params)
               throws StripeException

Retrieves the price with the given ID.

Throws:

StripeException

retrieve

public Price retrieve(String price,
 RequestOptions options)
               throws StripeException

Retrieves the price with the given ID.

Throws:

StripeException

retrieve

public Price retrieve(String price)
               throws StripeException

Retrieves the price with the given ID.

Throws:

StripeException

retrieve

public Price retrieve(String price,
 PriceRetrieveParams params,
 RequestOptions options)
               throws StripeException

Retrieves the price with the given ID.

Throws:

StripeException

update

public Price update(String price,
 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(String price,
 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

update

public Price update(String price)
             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(String price,
 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

search

public StripeSearchResult<Price> search(PriceSearchParams params)
                                 throws StripeException

Search for prices you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

Throws:

StripeException

search

public StripeSearchResult<Price> search(PriceSearchParams params,
 RequestOptions options)
                                 throws StripeException

Search for prices you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

Throws:

StripeException