Product.php 4.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * Products describe the specific goods or services you offer to your customers.
  6. * For example, you might offer a Standard and Premium version of your goods or
  7. * service; each version would be a separate Product. They can be used in
  8. * conjunction with <a href="https://stripe.com/docs/api#prices">Prices</a> to
  9. * configure pricing in Checkout and Subscriptions.
  10. *
  11. * Related guides: <a
  12. * href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up
  13. * a subscription</a> or accept <a
  14. * href="https://stripe.com/docs/payments/checkout/client#create-products">one-time
  15. * payments with Checkout</a> and more about <a
  16. * href="https://stripe.com/docs/billing/prices-guide">Products and Prices</a>
  17. *
  18. * @property string $id Unique identifier for the object.
  19. * @property string $object String representing the object's type. Objects of the same type share the same value.
  20. * @property bool $active Whether the product is currently available for purchase.
  21. * @property null|string[] $attributes A list of up to 5 attributes that each SKU can provide values for (e.g., <code>[&quot;color&quot;, &quot;size&quot;]</code>).
  22. * @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>.
  23. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  24. * @property string[] $deactivate_on An array of connect application identifiers that cannot purchase this product. Only applicable to products of <code>type=good</code>.
  25. * @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.
  26. * @property string[] $images A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
  27. * @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.
  28. * @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.
  29. * @property string $name The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
  30. * @property null|\Stripe\StripeObject $package_dimensions The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own <code>package_dimensions</code>. Only applicable to products of <code>type=good</code>.
  31. * @property null|bool $shippable Whether this product is a shipped good. Only applicable to products of <code>type=good</code>.
  32. * @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.
  33. * @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.
  34. * @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.
  35. * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
  36. * @property null|string $url A URL of a publicly-accessible webpage for this product. Only applicable to products of <code>type=good</code>.
  37. */
  38. class Product extends ApiResource
  39. {
  40. const OBJECT_NAME = 'product';
  41. use ApiOperations\All;
  42. use ApiOperations\Create;
  43. use ApiOperations\Delete;
  44. use ApiOperations\Retrieve;
  45. use ApiOperations\Update;
  46. const TYPE_GOOD = 'good';
  47. const TYPE_SERVICE = 'service';
  48. }