vendor/stripe/stripe-php/lib/Customer.php

   1 <?php
   2
   3 namespace Stripe;
   4
   5 /**
   6  * Class Customer
   7  *
   8  * @property string $id
   9  * @property string $object
  10  * @property int $account_balance
  11  * @property string $business_vat_id
  12  * @property string $created
  13  * @property string $currency
  14  * @property string $default_source
  15  * @property bool $delinquent
  16  * @property string $description
  17  * @property Discount $discount
  18  * @property string $email
  19  * @property string $invoice_prefix
  20  * @property bool $livemode
  21  * @property StripeObject $metadata
  22  * @property mixed $shipping
  23  * @property Collection $sources
  24  * @property Collection $subscriptions
  25  *
  26  * @package Stripe
  27  */
  28 class Customer extends ApiResource
  29 {
  30
  31     const OBJECT_NAME = "customer";
  32
  33     use ApiOperations\All;
  34     use ApiOperations\Create;
  35     use ApiOperations\Delete;
  36     use ApiOperations\NestedResource;
  37     use ApiOperations\Retrieve;
  38     use ApiOperations\Update;
  39
  40     public static function getSavedNestedResources()
  41     {
  42         static $savedNestedResources = null;
  43         if ($savedNestedResources === null) {
  44             $savedNestedResources = new Util\Set([
  45                 'source',
  46             ]);
  47         }
  48         return $savedNestedResources;
  49     }
  50
  51     const PATH_SOURCES = '/sources';
  52
  53     /**
  54      * @param array|null $params
  55      *
  56      * @return InvoiceItem The resulting invoice item.
  57      */
  58     public function addInvoiceItem($params = null)
  59     {
  60         $params = $params ?: [];
  61         $params['customer'] = $this->id;
  62         $ii = InvoiceItem::create($params, $this->_opts);
  63         return $ii;
  64     }
  65
  66     /**
  67      * @param array|null $params
  68      *
  69      * @return array An array of the customer's Invoices.
  70      */
  71     public function invoices($params = null)
  72     {
  73         $params = $params ?: [];
  74         $params['customer'] = $this->id;
  75         $invoices = Invoice::all($params, $this->_opts);
  76         return $invoices;
  77     }
  78
  79     /**
  80      * @param array|null $params
  81      *
  82      * @return array An array of the customer's InvoiceItems.
  83      */
  84     public function invoiceItems($params = null)
  85     {
  86         $params = $params ?: [];
  87         $params['customer'] = $this->id;
  88         $iis = InvoiceItem::all($params, $this->_opts);
  89         return $iis;
  90     }
  91
  92     /**
  93      * @param array|null $params
  94      *
  95      * @return array An array of the customer's Charges.
  96      */
  97     public function charges($params = null)
  98     {
  99         $params = $params ?: [];
 100         $params['customer'] = $this->id;
 101         $charges = Charge::all($params, $this->_opts);
 102         return $charges;
 103     }
 104
 105     /**
 106      * @param array|null $params
 107      *
 108      * @return Subscription The updated subscription.
 109      */
 110     public function updateSubscription($params = null)
 111     {
 112         $url = $this->instanceUrl() . '/subscription';
 113         list($response, $opts) = $this->_request('post', $url, $params);
 114         $this->refreshFrom(['subscription' => $response], $opts, true);
 115         return $this->subscription;
 116     }
 117
 118     /**
 119      * @param array|null $params
 120      *
 121      * @return Subscription The cancelled subscription.
 122      */
 123     public function cancelSubscription($params = null)
 124     {
 125         $url = $this->instanceUrl() . '/subscription';
 126         list($response, $opts) = $this->_request('delete', $url, $params);
 127         $this->refreshFrom(['subscription' => $response], $opts, true);
 128         return $this->subscription;
 129     }
 130
 131     /**
 132      * @return Customer The updated customer.
 133      */
 134     public function deleteDiscount()
 135     {
 136         $url = $this->instanceUrl() . '/discount';
 137         list($response, $opts) = $this->_request('delete', $url);
 138         $this->refreshFrom(['discount' => null], $opts, true);
 139     }
 140
 141     /**
 142      * @param array|null $id The ID of the customer on which to create the source.
 143      * @param array|null $params
 144      * @param array|string|null $opts
 145      *
 146      * @return ApiResource
 147      */
 148     public static function createSource($id, $params = null, $opts = null)
 149     {
 150         return self::_createNestedResource($id, static::PATH_SOURCES, $params, $opts);
 151     }
 152
 153     /**
 154      * @param array|null $id The ID of the customer to which the source belongs.
 155      * @param array|null $sourceId The ID of the source to retrieve.
 156      * @param array|null $params
 157      * @param array|string|null $opts
 158      *
 159      * @return ApiResource
 160      */
 161     public static function retrieveSource($id, $sourceId, $params = null, $opts = null)
 162     {
 163         return self::_retrieveNestedResource($id, static::PATH_SOURCES, $sourceId, $params, $opts);
 164     }
 165
 166     /**
 167      * @param array|null $id The ID of the customer to which the source belongs.
 168      * @param array|null $sourceId The ID of the source to update.
 169      * @param array|null $params
 170      * @param array|string|null $opts
 171      *
 172      * @return ApiResource
 173      */
 174     public static function updateSource($id, $sourceId, $params = null, $opts = null)
 175     {
 176         return self::_updateNestedResource($id, static::PATH_SOURCES, $sourceId, $params, $opts);
 177     }
 178
 179     /**
 180      * @param array|null $id The ID of the customer to which the source belongs.
 181      * @param array|null $sourceId The ID of the source to delete.
 182      * @param array|null $params
 183      * @param array|string|null $opts
 184      *
 185      * @return ApiResource
 186      */
 187     public static function deleteSource($id, $sourceId, $params = null, $opts = null)
 188     {
 189         return self::_deleteNestedResource($id, static::PATH_SOURCES, $sourceId, $params, $opts);
 190     }
 191
 192     /**
 193      * @param array|null $id The ID of the customer on which to retrieve the sources.
 194      * @param array|null $params
 195      * @param array|string|null $opts
 196      *
 197      * @return ApiResource
 198      */
 199     public static function allSources($id, $params = null, $opts = null)
 200     {
 201         return self::_allNestedResources($id, static::PATH_SOURCES, $params, $opts);
 202     }
 203 }