| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* You can now model subscriptions more flexibly using the <a |
| 9 |
* href="https://stripe.com/docs/api#prices">Prices API</a>. It replaces the Plans |
| 10 |
* API and is backwards compatible to simplify your migration. |
| 11 |
* |
| 12 |
* Plans define the base price, currency, and billing cycle for recurring purchases |
| 13 |
* of products. <a href="https://stripe.com/docs/api#products">Products</a> help |
| 14 |
* you track inventory or provisioning, and plans help you track pricing. Different |
| 15 |
* physical goods or levels of service should be represented by products, and |
| 16 |
* pricing options should be represented by plans. This approach lets you change |
| 17 |
* prices without having to change your provisioning scheme. |
| 18 |
* |
| 19 |
* For example, you might have a single "gold" product that has plans for |
| 20 |
* $10/month, $100/year, €9/month, and €90/year. |
| 21 |
* |
| 22 |
* Related guides: <a |
| 23 |
* href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up |
| 24 |
* a subscription</a> and more about <a |
| 25 |
* href="https://stripe.com/docs/products-prices/overview">products and prices</a>. |
| 26 |
* |
| 27 |
* @property string $id Unique identifier for the object. |
| 28 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 29 |
* @property bool $active Whether the plan can be used for new purchases. |
| 30 |
* @property null|string $aggregate_usage Specifies a usage aggregation strategy for plans of <code>usage_type=metered</code>. Allowed values are <code>sum</code> for summing up all usage during a period, <code>last_during_period</code> for using the last usage record reported within a period, <code>last_ever</code> for using the last usage record ever (across period bounds) or <code>max</code> which uses the usage record with the maximum reported usage during a period. Defaults to <code>sum</code>. |
| 31 |
* @property null|int $amount The unit amount in %s to be charged, represented as a whole integer if possible. Only set if <code>billing_scheme=per_unit</code>. |
| 32 |
* @property null|string $amount_decimal The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if <code>billing_scheme=per_unit</code>. |
| 33 |
* @property string $billing_scheme Describes how to compute the price per period. Either <code>per_unit</code> or <code>tiered</code>. <code>per_unit</code> indicates that the fixed amount (specified in <code>amount</code>) will be charged per unit in <code>quantity</code> (for plans with <code>usage_type=licensed</code>), or per unit of total usage (for plans with <code>usage_type=metered</code>). <code>tiered</code> indicates that the unit pricing will be computed using a tiering strategy as defined using the <code>tiers</code> and <code>tiers_mode</code> attributes. |
| 34 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 35 |
* @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>. |
| 36 |
* @property string $interval The frequency at which a subscription is billed. One of <code>day</code>, <code>week</code>, <code>month</code> or <code>year</code>. |
| 37 |
* @property int $interval_count The number of intervals (specified in the <code>interval</code> attribute) between subscription billings. For example, <code>interval=month</code> and <code>interval_count=3</code> bills every 3 months. |
| 38 |
* @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. |
| 39 |
* @property null|\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. |
| 40 |
* @property null|string $nickname A brief description of the plan, hidden from customers. |
| 41 |
* @property null|string|\Stripe\Product $product The product whose pricing this plan determines. |
| 42 |
* @property \Stripe\StripeObject[] $tiers Each element represents a pricing tier. This parameter requires <code>billing_scheme</code> to be set to <code>tiered</code>. See also the documentation for <code>billing_scheme</code>. |
| 43 |
* @property null|string $tiers_mode Defines if the tiering price should be <code>graduated</code> or <code>volume</code> based. In <code>volume</code>-based tiering, the maximum quantity within a period determines the per unit price. In <code>graduated</code> tiering, pricing can change as the quantity grows. |
| 44 |
* @property null|\Stripe\StripeObject $transform_usage Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with <code>tiers</code>. |
| 45 |
* @property null|int $trial_period_days Default number of trial days when subscribing a customer to this plan using <a href="https://stripe.com/docs/api#create_subscription-trial_from_plan"><code>trial_from_plan=true</code></a>. |
| 46 |
* @property string $usage_type Configures how the quantity per period should be determined. Can be either <code>metered</code> or <code>licensed</code>. <code>licensed</code> automatically bills the <code>quantity</code> set when adding it to a subscription. <code>metered</code> aggregates the total usage based on usage records. Defaults to <code>licensed</code>. |
| 47 |
*/ |
| 48 |
class Plan extends ApiResource |
| 49 |
{ |
| 50 |
const OBJECT_NAME = 'plan'; |
| 51 |
|
| 52 |
use ApiOperations\All; |
| 53 |
use ApiOperations\Create; |
| 54 |
use ApiOperations\Delete; |
| 55 |
use ApiOperations\Retrieve; |
| 56 |
use ApiOperations\Update; |
| 57 |
} |
| 58 |
|
