update stripe-php 7.67.0

htdocs/includes/stripe/stripe-php/lib/SubscriptionSchedule.php

@@ -1,68 +1,74 @@
 <?php
 
+// File generated from our OpenAPI spec
+
 namespace Stripe;
 
 /**
- * Class SubscriptionSchedule
+ * A subscription schedule allows you to create and manage the lifecycle of a
+ * subscription by predefining expected changes.
  *
- * @property string $id
- * @property string $object
- * @property string $billing
- * @property mixed $billing_thresholds
- * @property int $canceled_at
- * @property int $completed_at
- * @property int $created
- * @property mixed $current_phase
- * @property string $customer
- * @property mixed $invoice_settings
- * @property boolean $livemode
- * @property StripeObject $metadata
- * @property mixed $phases
- * @property int $released_at
- * @property string $released_subscription
- * @property string $renewal_behavior
- * @property mixed $renewal_interval
- * @property string $revision
- * @property string $status
- * @property string $subscription
+ * Related guide: <a
+ * href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">Subscription
+ * Schedules</a>.
  *
- * @package Stripe
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property null|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
+ * @property null|int $completed_at Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|\Stripe\StripeObject $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is <code>active</code>.
+ * @property string|\Stripe\Customer $customer ID of the customer who owns the subscription schedule.
+ * @property \Stripe\StripeObject $default_settings
+ * @property string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends. Possible values are <code>release</code> and <code>cancel</code>.
+ * @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.
+ * @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.
+ * @property \Stripe\StripeObject[] $phases Configuration for the subscription schedule's phases.
+ * @property null|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
+ * @property null|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released).
+ * @property string $status The present status of the subscription schedule. Possible values are <code>not_started</code>, <code>active</code>, <code>completed</code>, <code>released</code>, and <code>canceled</code>. You can read more about the different states in our <a href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">behavior guide</a>.
+ * @property null|string|\Stripe\Subscription $subscription ID of the subscription managed by the subscription schedule.
  */
 class SubscriptionSchedule extends ApiResource
 {
-    const OBJECT_NAME = "subscription_schedule";
+    const OBJECT_NAME = 'subscription_schedule';
 
     use ApiOperations\All;
     use ApiOperations\Create;
     use ApiOperations\Retrieve;
     use ApiOperations\Update;
-    use ApiOperations\NestedResource;
 
     /**
-     * @param array|null $params
-     * @param array|string|null $opts
+     * @param null|array $params
+     * @param null|array|string $opts
      *
-     * @return SubscriptionSchedule The canceled subscription schedule.
+     * @throws \Stripe\Exception\ApiErrorException if the request fails
+     *
+     * @return SubscriptionSchedule the canceled subscription schedule
      */
     public function cancel($params = null, $opts = null)
     {
         $url = $this->instanceUrl() . '/cancel';
         list($response, $opts) = $this->_request('post', $url, $params, $opts);
         $this->refreshFrom($response, $opts);
+
         return $this;
     }
 
     /**
-     * @param array|null $params
-     * @param array|string|null $opts
+     * @param null|array $params
+     * @param null|array|string $opts
      *
-     * @return SubscriptionSchedule The released subscription schedule.
+     * @throws \Stripe\Exception\ApiErrorException if the request fails
+     *
+     * @return SubscriptionSchedule the released subscription schedule
      */
     public function release($params = null, $opts = null)
     {
         $url = $this->instanceUrl() . '/release';
         list($response, $opts) = $this->_request('post', $url, $params, $opts);
         $this->refreshFrom($response, $opts);
+
         return $this;
     }
 }