give / vendor / stripe / stripe-php / lib / Product.php

Product.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.5, at vendor/stripe/stripe-php/lib/Product.php

74 lines 4.6 KB

Raw Download Zip

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
10	* service; each version would be a separate Product. They can be used in
11	* conjunction with <a href="https://stripe.com/docs/api#prices">Prices</a> to
12	* configure pricing in Payment Links, Checkout, and Subscriptions.
13	*
14	* Related guides: <a
15	* href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up
16	* a subscription</a>, <a
17	* href="https://stripe.com/docs/payments/payment-links/overview">share a Payment
18	* Link</a>, <a
19	* href="https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront">accept
20	* payments with Checkout</a>, and more about <a
21	* href="https://stripe.com/docs/products-prices/overview">Products and Prices</a>
22	*
23	* @property string $id Unique identifier for the object.
24	* @property string $object String representing the object's type. Objects of the same type share the same value.
25	* @property bool $active Whether the product is currently available for purchase.
26	* @property null\|string[] $attributes A list of up to 5 attributes that each SKU can provide values for (e.g., <code>["color", "size"]</code>).
27	* @property null\|string $caption A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of <code>type=good</code>.
28	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
29	* @property string[] $deactivate_on An array of connect application identifiers that cannot purchase this product. Only applicable to products of <code>type=good</code>.
30	* @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.
31	* @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.
32	* @property string[] $images A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
33	* @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.
34	* @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.
35	* @property string $name The product's name, meant to be displayable to the customer.
36	* @property null\|\Stripe\StripeObject $package_dimensions The dimensions of this product for shipping purposes.
37	* @property null\|bool $shippable Whether this product is shipped (i.e., physical goods).
38	* @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.
39	* @property null\|string\|\Stripe\TaxCode $tax_code A <a href="https://stripe.com/docs/tax/tax-categories">tax code</a> ID.
40	* @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.
41	* @property null\|string $unit_label A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
42	* @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
43	* @property null\|string $url A URL of a publicly-accessible webpage for this product.
44	*/
45	class Product extends ApiResource
46	{
47	const OBJECT_NAME = 'product';
48
49	use ApiOperations\All;
50	use ApiOperations\Create;
51	use ApiOperations\Delete;
52	use ApiOperations\Retrieve;
53	use ApiOperations\Search;
54	use ApiOperations\Update;
55
56	const TYPE_GOOD = 'good';
57	const TYPE_SERVICE = 'service';
58
59	/**
60	* @param null\|array $params
61	* @param null\|array\|string $opts
62	*
63	* @throws \Stripe\Exception\ApiErrorException if the request fails
64	*
65	* @return \Stripe\SearchResult<Product> the product search results
66	*/
67	public static function search($params = null, $opts = null)
68	{
69	$url = '/v1/products/search';
70
71	return self::_searchResource($url, $params, $opts);
72	}
73	}
74