ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
SubscriptionSchedule.php
77 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * A subscription schedule allows you to create and manage the lifecycle of a |
| 9 | * subscription by predefining expected changes. |
| 10 | * |
| 11 | * Related guide: <a |
| 12 | * href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">Subscription |
| 13 | * Schedules</a>. |
| 14 | * |
| 15 | * @property string $id Unique identifier for the object. |
| 16 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 17 | * @property null|string|\Stripe\StripeObject $application ID of the Connect Application that created the schedule. |
| 18 | * @property null|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. |
| 19 | * @property null|int $completed_at Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. |
| 20 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 21 | * @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>. |
| 22 | * @property string|\Stripe\Customer $customer ID of the customer who owns the subscription schedule. |
| 23 | * @property \Stripe\StripeObject $default_settings |
| 24 | * @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>. |
| 25 | * @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. |
| 26 | * @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. |
| 27 | * @property \Stripe\StripeObject[] $phases Configuration for the subscription schedule's phases. |
| 28 | * @property null|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. |
| 29 | * @property null|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released). |
| 30 | * @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>. |
| 31 | * @property null|string|\Stripe\Subscription $subscription ID of the subscription managed by the subscription schedule. |
| 32 | * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this subscription schedule belongs to. |
| 33 | */ |
| 34 | class SubscriptionSchedule extends ApiResource |
| 35 | { |
| 36 | const OBJECT_NAME = 'subscription_schedule'; |
| 37 | |
| 38 | use ApiOperations\All; |
| 39 | use ApiOperations\Create; |
| 40 | use ApiOperations\Retrieve; |
| 41 | use ApiOperations\Update; |
| 42 | |
| 43 | /** |
| 44 | * @param null|array $params |
| 45 | * @param null|array|string $opts |
| 46 | * |
| 47 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 48 | * |
| 49 | * @return \Stripe\SubscriptionSchedule the canceled subscription schedule |
| 50 | */ |
| 51 | public function cancel($params = null, $opts = null) |
| 52 | { |
| 53 | $url = $this->instanceUrl() . '/cancel'; |
| 54 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 55 | $this->refreshFrom($response, $opts); |
| 56 | |
| 57 | return $this; |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * @param null|array $params |
| 62 | * @param null|array|string $opts |
| 63 | * |
| 64 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 65 | * |
| 66 | * @return \Stripe\SubscriptionSchedule the released subscription schedule |
| 67 | */ |
| 68 | public function release($params = null, $opts = null) |
| 69 | { |
| 70 | $url = $this->instanceUrl() . '/release'; |
| 71 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 72 | $this->refreshFrom($response, $opts); |
| 73 | |
| 74 | return $this; |
| 75 | } |
| 76 | } |
| 77 |