[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  class Stripe_Invoice extends Stripe_ApiResource
   4  {
   5    /**
   6     * @param array|null $params
   7     * @param string|null $apiKey
   8     *
   9     * @return Stripe_Invoice The created invoice.
  10     */
  11    public static function create($params=null, $apiKey=null)
  12    {
  13      $class = get_class();
  14      return self::_scopedCreate($class, $params, $apiKey);
  15    }
  16  
  17    /**
  18     * @param string $id The ID of the invoice to retrieve.
  19     * @param string|null $apiKey
  20     *
  21     * @return Stripe_Invoice
  22     */
  23    public static function retrieve($id, $apiKey=null)
  24    {
  25      $class = get_class();
  26      return self::_scopedRetrieve($class, $id, $apiKey);
  27    }
  28  
  29    /**
  30     * @param array|null $params
  31     * @param string|null $apiKey
  32     *
  33     * @return array An array of Stripe_Invoices.
  34     */
  35    public static function all($params=null, $apiKey=null)
  36    {
  37      $class = get_class();
  38      return self::_scopedAll($class, $params, $apiKey);
  39    }
  40  
  41    /**
  42     * @param array|null $params
  43     * @param string|null $apiKey
  44     *
  45     * @return Stripe_Invoice The upcoming invoice.
  46     */
  47    public static function upcoming($params=null, $apiKey=null)
  48    {
  49      $requestor = new Stripe_ApiRequestor($apiKey);
  50      $url = self::classUrl(get_class()) . '/upcoming';
  51      list($response, $apiKey) = $requestor->request('get', $url, $params);
  52      return Stripe_Util::convertToStripeObject($response, $apiKey);
  53    }
  54  
  55    /**
  56     * @return Stripe_Invoice The saved invoice.
  57     */
  58    public function save()
  59    {
  60      $class = get_class();
  61      return self::_scopedSave($class);
  62    }
  63  
  64    /**
  65     * @return Stripe_Invoice The paid invoice.
  66     */
  67    public function pay()
  68    {
  69      $requestor = new Stripe_ApiRequestor($this->_apiKey);
  70      $url = $this->instanceUrl() . '/pay';
  71      list($response, $apiKey) = $requestor->request('post', $url);
  72      $this->refreshFrom($response, $apiKey);
  73      return $this;
  74    }
  75  }