Package com.stripe.service

Class ProductService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.ProductService

public final class ProductService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
ProductService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Product	create(ProductCreateParams params)	Creates a new product object.
Product	create(ProductCreateParams params, RequestOptions options)	Creates a new product object.
Product	delete(String id)	Delete a product.
Product	delete(String id, RequestOptions options)	Delete a product.
ProductFeatureService	features()
StripeCollection<Product>	list()	Returns a list of your products.
StripeCollection<Product>	list(RequestOptions options)	Returns a list of your products.
StripeCollection<Product>	list(ProductListParams params)	Returns a list of your products.
StripeCollection<Product>	list(ProductListParams params, RequestOptions options)	Returns a list of your products.
Product	retrieve(String id)	Retrieves the details of an existing product.
Product	retrieve(String id, RequestOptions options)	Retrieves the details of an existing product.
Product	retrieve(String id, ProductRetrieveParams params)	Retrieves the details of an existing product.
Product	retrieve(String id, ProductRetrieveParams params, RequestOptions options)	Retrieves the details of an existing product.
StripeSearchResult<Product>	search(ProductSearchParams params)	Search for products you’ve previously created using Stripe’s Search Query Language.
StripeSearchResult<Product>	search(ProductSearchParams params, RequestOptions options)	Search for products you’ve previously created using Stripe’s Search Query Language.
Product	update(String id)	Updates the specific product by setting the values of the parameters passed.
Product	update(String id, RequestOptions options)	Updates the specific product by setting the values of the parameters passed.
Product	update(String id, ProductUpdateParams params)	Updates the specific product by setting the values of the parameters passed.
Product	update(String id, ProductUpdateParams params, RequestOptions options)	Updates the specific product 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

ProductService

public ProductService(StripeResponseGetter responseGetter)

Method Details

delete

public Product delete(String id)
               throws StripeException

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

Throws:

StripeException

delete

public Product delete(String id,
 RequestOptions options)
               throws StripeException

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

Throws:

StripeException

retrieve

public Product retrieve(String id,
 ProductRetrieveParams params)
                 throws StripeException

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

Throws:

StripeException

retrieve

public Product retrieve(String id,
 RequestOptions options)
                 throws StripeException

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

Throws:

StripeException

retrieve

public Product retrieve(String id)
                 throws StripeException

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

Throws:

StripeException

retrieve

public Product retrieve(String id,
 ProductRetrieveParams params,
 RequestOptions options)
                 throws StripeException

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

Throws:

StripeException

update

public Product update(String id,
 ProductUpdateParams params)
               throws StripeException

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Throws:

StripeException

update

public Product update(String id,
 RequestOptions options)
               throws StripeException

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Throws:

StripeException

update

public Product update(String id)
               throws StripeException

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Throws:

StripeException

update

public Product update(String id,
 ProductUpdateParams params,
 RequestOptions options)
               throws StripeException

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Throws:

StripeException

list

public StripeCollection<Product> list(ProductListParams params)
                               throws StripeException

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

Throws:

StripeException

list

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

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

Throws:

StripeException

list

public StripeCollection<Product> list()
                               throws StripeException

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

Throws:

StripeException

list

public StripeCollection<Product> list(ProductListParams params,
 RequestOptions options)
                               throws StripeException

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

Throws:

StripeException

create

public Product create(ProductCreateParams params)
               throws StripeException

Creates a new product object.

Throws:

StripeException

create

public Product create(ProductCreateParams params,
 RequestOptions options)
               throws StripeException

Creates a new product object.

Throws:

StripeException

search

public StripeSearchResult<Product> search(ProductSearchParams params)
                                   throws StripeException

Search for products 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<Product> search(ProductSearchParams params,
 RequestOptions options)
                                   throws StripeException

Search for products 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

features

public ProductFeatureService features()