vendor/stripe/stripe-php/lib/Subscription.php

   1 <?php
   2
   3 namespace Stripe;
   4
   5 /**
   6  * Class Subscription
   7  *
   8  * @property string $id
   9  * @property string $object
  10  * @property float $application_fee_percent
  11  * @property string $billing
  12  * @property int $billing_cycle_anchor
  13  * @property bool $cancel_at_period_end
  14  * @property int $canceled_at
  15  * @property int $created
  16  * @property int current_period_end
  17  * @property int current_period_start
  18  * @property string $customer
  19  * @property int $days_until_due
  20  * @property Discount $discount
  21  * @property int $ended_at
  22  * @property Collection $items
  23  * @property boolean $livemode
  24  * @property StripeObject $metadata
  25  * @property Plan $plan
  26  * @property int $quantity
  27  * @property int $start
  28  * @property string $status
  29  * @property float $tax_percent
  30  * @property int $trial_end
  31  * @property int $trial_start
  32  *
  33  * @package Stripe
  34  */
  35 class Subscription extends ApiResource
  36 {
  37
  38     const OBJECT_NAME = "subscription";
  39
  40     use ApiOperations\All;
  41     use ApiOperations\Create;
  42     use ApiOperations\Delete {
  43         delete as protected _delete;
  44     }
  45     use ApiOperations\Retrieve;
  46     use ApiOperations\Update;
  47
  48     /**
  49      * These constants are possible representations of the status field.
  50      *
  51      * @link https://stripe.com/docs/api#subscription_object-status
  52      */
  53     const STATUS_ACTIVE   = 'active';
  54     const STATUS_CANCELED = 'canceled';
  55     const STATUS_PAST_DUE = 'past_due';
  56     const STATUS_TRIALING = 'trialing';
  57     const STATUS_UNPAID   = 'unpaid';
  58
  59     public static function getSavedNestedResources()
  60     {
  61         static $savedNestedResources = null;
  62         if ($savedNestedResources === null) {
  63             $savedNestedResources = new Util\Set([
  64                 'source',
  65             ]);
  66         }
  67         return $savedNestedResources;
  68     }
  69
  70     /**
  71      * @param array|null $params
  72      *
  73      * @return Subscription The deleted subscription.
  74      */
  75     public function cancel($params = null, $opts = null)
  76     {
  77         return $this->_delete($params, $opts);
  78     }
  79
  80     /**
  81      * @return Subscription The updated subscription.
  82      */
  83     public function deleteDiscount()
  84     {
  85         $url = $this->instanceUrl() . '/discount';
  86         list($response, $opts) = $this->_request('delete', $url);
  87         $this->refreshFrom(['discount' => null], $opts, true);
  88     }
  89 }