@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

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.

@required @param id [String?] @return [Stripe::DeletedProduct]

<p>Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with <code>type=good</code> is only possible if it has no SKUs associated with it.</p> @required @param id [String?] @return nil

<p>Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with <code>type=good</code> is only possible if it has no SKUs associated with it.</p> @required @param id [String?] @return [Tuple(Stripe::DeletedProduct, Integer, Hash)] Stripe::DeletedProduct, response status code and response headers

Deletes the feature attachment to a product

@required @param id [String?] @required @param product [String?] @return [Stripe::DeletedProductFeature]

<p>Deletes the feature attachment to a product</p> @required @param id [String?] @required @param product [String?] @return nil

<p>Deletes the feature attachment to a product</p> @required @param id [String?] @required @param product [String?] @return [Tuple(Stripe::DeletedProductFeature, Integer, Hash)] Stripe::DeletedProductFeature, response status code and response headers

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

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param _type [String?] Only return products of this type. @optional @param active [Bool?] Only return products that are active or inactive (e.g., pass `false` to list all inactive products). @optional @param shippable [Bool?] Only return products that can be shipped (i.e., physical, not digital products). @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return products that were created during the given date interval. @optional @param ids [Array(Array(String))?] Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before). @optional @param url [String?] Only return products with the given url. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ProductList]

<p>Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param _type [String?] Only return products of this type. @optional @param active [Bool?] Only return products that are active or inactive (e.g., pass false to list all inactive products). @optional @param shippable [Bool?] Only return products that can be shipped (i.e., physical, not digital products). @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return products that were created during the given date interval. @optional @param ids [Array(Array(String))?] Only return products with the given IDs. Cannot be used with starting_after or ending_before. @optional @param url [String?] Only return products with the given url. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

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.

@required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::Product]

<p>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.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>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.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Product, Integer, Hash)] Stripe::Product, response status code and response headers

Retrieve a list of features for a product

@required @param product [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::EntitlementsResourceProductFeatureList]

<p>Retrieve a list of features for a product</p> @required @param product [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

Retrieves a product_feature, which represents a feature attachment to a product

@required @param product [String?] The ID of the product. @required @param id [String?] The ID of the product_feature. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ProductFeature]

<p>Retrieves a product_feature, which represents a feature attachment to a product</p> @required @param product [String?] The ID of the product. @required @param id [String?] The ID of the product_feature. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>Retrieves a product_feature, which represents a feature attachment to a product</p> @required @param product [String?] The ID of the product. @required @param id [String?] The ID of the product_feature. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ProductFeature, Integer, Hash)] Stripe::ProductFeature, response status code and response headers

<p>Retrieve a list of features for a product</p> @required @param product [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::EntitlementsResourceProductFeatureList, Integer, Hash)] Stripe::EntitlementsResourceProductFeatureList, response status code and response headers

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.

@required @param query [String?] The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products). @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::SearchResult]

<p>Search for products you’ve previously created using Stripe’s <a href=&quot;/docs/search#search-query-language&quot;>Search Query Language</a>. 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.</p> @required @param query [String?] The search query string. See search query language and the list of supported query fields for products. @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>Search for products you’ve previously created using Stripe’s <a href=&quot;/docs/search#search-query-language&quot;>Search Query Language</a>. 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.</p> @required @param query [String?] The search query string. See search query language and the list of supported query fields for products. @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::SearchResult, Integer, Hash)] Stripe::SearchResult, response status code and response headers

<p>Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param _type [String?] Only return products of this type. @optional @param active [Bool?] Only return products that are active or inactive (e.g., pass false to list all inactive products). @optional @param shippable [Bool?] Only return products that can be shipped (i.e., physical, not digital products). @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return products that were created during the given date interval. @optional @param ids [Array(Array(String))?] Only return products with the given IDs. Cannot be used with starting_after or ending_before. @optional @param url [String?] Only return products with the given url. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ProductList, Integer, Hash)] Stripe::ProductList, response status code and response headers

Creates a new product object.

@required @param name [String?] The product's name, meant to be displayable to the customer. @optional @param active [Bool?] Whether the product is currently available for purchase. Defaults to `true`. @optional @param default_price_data [Stripe::PriceDataWithoutProduct?] @optional @param description [String?] The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param id [String?] An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. @optional @param images [Array(String)?] A list of up to 8 URLs of images for this product, meant to be displayable to the customer. @optional @param marketing_features [Array(Stripe::Features)?] A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). @optional @param metadata [Hash(String, String)?] @optional @param package_dimensions [Stripe::PackageDimensionsSpecs?] @optional @param shippable [Bool?] Whether this product is shipped (i.e., physical goods). @optional @param statement_descriptor [String?] An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\\\\`, `\\\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. Only used for subscription payments. @optional @param tax_code [String?] A [tax code](https://stripe.com/docs/tax/tax-categories) ID. @optional @param _type [String?] The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons. @optional @param unit_label [String?] A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. @optional @param url [String?] A URL of a publicly-accessible webpage for this product. @return [Stripe::Product]

<p>Creates a new product object.</p> @required @param name [String?] The product's name, meant to be displayable to the customer. @optional @param active [Bool?] Whether the product is currently available for purchase. Defaults to true. @optional @param default_price_data [Stripe::PriceDataWithoutProduct?] @optional @param description [String?] The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param id [String?] An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. @optional @param images [Array(String)?] A list of up to 8 URLs of images for this product, meant to be displayable to the customer. @optional @param marketing_features [Array(Stripe::Features)?] A list of up to 15 marketing features for this product. These are displayed in pricing tables. @optional @param metadata [Hash(String, String)?] @optional @param package_dimensions [Stripe::PackageDimensionsSpecs?] @optional @param shippable [Bool?] Whether this product is shipped (i.e., physical goods). @optional @param statement_descriptor [String?] An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include <, >, \\\\, \\\", ' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. Only used for subscription payments. @optional @param tax_code [String?] A tax code ID. @optional @param _type [String?] The type of the product. Defaults to service if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to good to use this product with Orders and SKUs. On API versions before 2018-02-05, this field defaults to good for compatibility reasons. @optional @param unit_label [String?] A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. @optional @param url [String?] A URL of a publicly-accessible webpage for this product. @return nil

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

@required @param id [String?] @optional @param active [Bool?] Whether the product is available for purchase. @optional @param default_price [String?] The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. @optional @param description [Stripe::PostProductsIdRequestDescription?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param images [Stripe::PostProductsIdRequestImages?] @optional @param marketing_features [Stripe::PostProductsIdRequestMarketingFeatures?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] The product's name, meant to be displayable to the customer. @optional @param package_dimensions [Stripe::PostProductsIdRequestPackageDimensions?] @optional @param shippable [Bool?] Whether this product is shipped (i.e., physical goods). @optional @param statement_descriptor [String?] An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\\\\`, `\\\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments. @optional @param tax_code [Stripe::PostInvoiceitemsRequestTaxCode?] @optional @param unit_label [Stripe::PostProductsIdRequestUnitLabel?] @optional @param url [Stripe::PostProductsIdRequestUrl?] @return [Stripe::Product]

<p>Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> @required @param id [String?] @optional @param active [Bool?] Whether the product is available for purchase. @optional @param default_price [String?] The ID of the Price object that is the default price for this product. @optional @param description [Stripe::PostProductsIdRequestDescription?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param images [Stripe::PostProductsIdRequestImages?] @optional @param marketing_features [Stripe::PostProductsIdRequestMarketingFeatures?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] The product's name, meant to be displayable to the customer. @optional @param package_dimensions [Stripe::PostProductsIdRequestPackageDimensions?] @optional @param shippable [Bool?] Whether this product is shipped (i.e., physical goods). @optional @param statement_descriptor [String?] An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include <, >, \\\\, \\\", ' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. May only be set if type=service. Only used for subscription payments. @optional @param tax_code [Stripe::PostInvoiceitemsRequestTaxCode?] @optional @param unit_label [Stripe::PostProductsIdRequestUnitLabel?] @optional @param url [Stripe::PostProductsIdRequestUrl?] @return nil

<p>Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> @required @param id [String?] @optional @param active [Bool?] Whether the product is available for purchase. @optional @param default_price [String?] The ID of the Price object that is the default price for this product. @optional @param description [Stripe::PostProductsIdRequestDescription?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param images [Stripe::PostProductsIdRequestImages?] @optional @param marketing_features [Stripe::PostProductsIdRequestMarketingFeatures?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] The product's name, meant to be displayable to the customer. @optional @param package_dimensions [Stripe::PostProductsIdRequestPackageDimensions?] @optional @param shippable [Bool?] Whether this product is shipped (i.e., physical goods). @optional @param statement_descriptor [String?] An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include <, >, \\\\, \\\", ' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. May only be set if type=service. Only used for subscription payments. @optional @param tax_code [Stripe::PostInvoiceitemsRequestTaxCode?] @optional @param unit_label [Stripe::PostProductsIdRequestUnitLabel?] @optional @param url [Stripe::PostProductsIdRequestUrl?] @return [Tuple(Stripe::Product, Integer, Hash)] Stripe::Product, response status code and response headers

Creates a product_feature, which represents a feature attachment to a product

@required @param product [String?] @required @param entitlement_feature [String?] The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::ProductFeature]

<p>Creates a product_feature, which represents a feature attachment to a product</p> @required @param product [String?] @required @param entitlement_feature [String?] The ID of the Feature object attached to this product. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil

<p>Creates a product_feature, which represents a feature attachment to a product</p> @required @param product [String?] @required @param entitlement_feature [String?] The ID of the Feature object attached to this product. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ProductFeature, Integer, Hash)] Stripe::ProductFeature, response status code and response headers

<p>Creates a new product object.</p> @required @param name [String?] The product's name, meant to be displayable to the customer. @optional @param active [Bool?] Whether the product is currently available for purchase. Defaults to true. @optional @param default_price_data [Stripe::PriceDataWithoutProduct?] @optional @param description [String?] The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param id [String?] An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. @optional @param images [Array(String)?] A list of up to 8 URLs of images for this product, meant to be displayable to the customer. @optional @param marketing_features [Array(Stripe::Features)?] A list of up to 15 marketing features for this product. These are displayed in pricing tables. @optional @param metadata [Hash(String, String)?] @optional @param package_dimensions [Stripe::PackageDimensionsSpecs?] @optional @param shippable [Bool?] Whether this product is shipped (i.e., physical goods). @optional @param statement_descriptor [String?] An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include <, >, \\\\, \\\", ' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. Only used for subscription payments. @optional @param tax_code [String?] A tax code ID. @optional @param _type [String?] The type of the product. Defaults to service if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to good to use this product with Orders and SKUs. On API versions before 2018-02-05, this field defaults to good for compatibility reasons. @optional @param unit_label [String?] A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. @optional @param url [String?] A URL of a publicly-accessible webpage for this product. @return [Tuple(Stripe::Product, Integer, Hash)] Stripe::Product, response status code and response headers