SKU.php 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * Stores representations of <a
  6. * href="http://en.wikipedia.org/wiki/Stock_keeping_unit">stock keeping units</a>.
  7. * SKUs describe specific product variations, taking into account any combination
  8. * of: attributes, currency, and cost. For example, a product may be a T-shirt,
  9. * whereas a specific SKU represents the <code>size: large</code>, <code>color:
  10. * red</code> version of that shirt.
  11. *
  12. * Can also be used to manage inventory.
  13. *
  14. * Related guide: <a href="https://stripe.com/docs/orders">Tax, Shipping, and
  15. * Inventory</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 SKU is available for purchase.
  20. * @property \Stripe\StripeObject $attributes A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are <code>[&quot;size&quot;, &quot;gender&quot;]</code>, a valid SKU has the following dictionary of attributes: <code>{&quot;size&quot;: &quot;Medium&quot;, &quot;gender&quot;: &quot;Unisex&quot;}</code>.
  21. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  22. * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
  23. * @property null|string $image The URL of an image for this SKU, meant to be displayable to the customer.
  24. * @property \Stripe\StripeObject $inventory
  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 null|\Stripe\StripeObject $package_dimensions The dimensions of this SKU for shipping purposes.
  28. * @property int $price The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).
  29. * @property string|\Stripe\Product $product The ID of the product this SKU is associated with. The product must be currently active.
  30. * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
  31. */
  32. class SKU extends ApiResource
  33. {
  34. const OBJECT_NAME = 'sku';
  35. use ApiOperations\All;
  36. use ApiOperations\Create;
  37. use ApiOperations\Delete;
  38. use ApiOperations\Retrieve;
  39. use ApiOperations\Update;
  40. }