72 lines
2.0 KiB
PHP
Executable File

<?php
namespace Stripe;
/**
* Class SubscriptionSchedule
*
* @property string $id
* @property string $object
* @property mixed|null $billing_thresholds
* @property int|null $canceled_at
* @property string|null $collection_method
* @property int|null $completed_at
* @property int $created
* @property mixed|null $current_phase
* @property string $customer
* @property string|null $default_payment_method
* @property string $end_behavior
* @property mixed|null $invoice_settings
* @property bool $livemode
* @property \Stripe\StripeObject|null $metadata
* @property mixed $phases
* @property int|null $released_at
* @property string|null $released_subscription
* @property mixed|null $renewal_interval
* @property string $status
* @property string|null $subscription
*
* @package Stripe
*/
class SubscriptionSchedule extends ApiResource
{
const OBJECT_NAME = 'subscription_schedule';
use ApiOperations\All;
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
/**
* @param array|null $params
* @param array|string|null $opts
*
* @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
*
* @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;
}
}