• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

stripe / stripe-php / 6471862601

10 Oct 2023 04:02PM UTC coverage: 69.665% (-0.5%) from 70.141%
6471862601

push

github

web-flow
Merge pull request #1570 from localheinz/feature/coveralls

Enhancement: Use `coverallsapp/github-action` to report code coverage

2393 of 3435 relevant lines covered (69.67%)

3.5 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0
/lib/Product.php
1
<?php
2

3
// File generated from our OpenAPI spec
4

5
namespace Stripe;
6

7
/**
8
 * Products describe the specific goods or services you offer to your customers.
9
 * For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
10
 * They can be used in conjunction with <a href="https://stripe.com/docs/api#prices">Prices</a> to configure pricing in Payment Links, Checkout, and Subscriptions.
11
 *
12
 * Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a>,
13
 * <a href="https://stripe.com/docs/payment-links">share a Payment Link</a>,
14
 * <a href="https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront">accept payments with Checkout</a>,
15
 * and more about <a href="https://stripe.com/docs/products-prices/overview">Products and Prices</a>
16
 *
17
 * @property string $id Unique identifier for the object.
18
 * @property string $object String representing the object's type. Objects of the same type share the same value.
19
 * @property bool $active Whether the product is currently available for purchase.
20
 * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
21
 * @property null|string|\Stripe\Price $default_price The ID of the <a href="https://stripe.com/docs/api/prices">Price</a> object that is the default price for this product.
22
 * @property null|string $description 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.
23
 * @property \Stripe\StripeObject[] $features A list of up to 15 features for this product. These are displayed in <a href="https://stripe.com/docs/payments/checkout/pricing-table">pricing tables</a>.
24
 * @property string[] $images A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
25
 * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
26
 * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
27
 * @property string $name The product's name, meant to be displayable to the customer.
28
 * @property null|\Stripe\StripeObject $package_dimensions The dimensions of this product for shipping purposes.
29
 * @property null|bool $shippable Whether this product is shipped (i.e., physical goods).
30
 * @property null|string $statement_descriptor Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.
31
 * @property null|string|\Stripe\TaxCode $tax_code A <a href="https://stripe.com/docs/tax/tax-categories">tax code</a> ID.
32
 * @property string $type The type of the product. The product is either of type <code>good</code>, which is eligible for use with Orders and SKUs, or <code>service</code>, which is eligible for use with Subscriptions and Plans.
33
 * @property null|string $unit_label A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
34
 * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
35
 * @property null|string $url A URL of a publicly-accessible webpage for this product.
36
 */
37
class Product extends ApiResource
38
{
39
    const OBJECT_NAME = 'product';
40

41
    use ApiOperations\All;
42
    use ApiOperations\Create;
43
    use ApiOperations\Delete;
44
    use ApiOperations\Retrieve;
45
    use ApiOperations\Search;
46
    use ApiOperations\Update;
47

48
    const TYPE_GOOD = 'good';
49
    const TYPE_SERVICE = 'service';
50

51
    /**
52
     * @param null|array $params
53
     * @param null|array|string $opts
54
     *
55
     * @throws \Stripe\Exception\ApiErrorException if the request fails
56
     *
57
     * @return \Stripe\SearchResult<\Stripe\Product> the product search results
58
     */
59
    public static function search($params = null, $opts = null)
×
60
    {
61
        $url = '/v1/products/search';
×
62

63
        return self::_searchResource($url, $params, $opts);
×
64
    }
65
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc