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
SubscriptionItem.php
85 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * Subscription items allow you to create customer subscriptions with more than one |
| 9 | * plan, making it easy to represent complex billing relationships. |
| 10 | * |
| 11 | * @property string $id Unique identifier for the object. |
| 12 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 13 | * @property null|\Stripe\StripeObject $billing_thresholds Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period |
| 14 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 15 | * @property \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. |
| 16 | * @property \Stripe\Plan $plan <p>You can now model subscriptions more flexibly using the <a href="https://stripe.com/docs/api#prices">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.</p><p>Plans define the base price, currency, and billing cycle for recurring purchases of products. <a href="https://stripe.com/docs/api#products">Products</a> help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.</p><p>For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.</p><p>Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a> and more about <a href="https://stripe.com/docs/products-prices/overview">products and prices</a>.</p> |
| 17 | * @property \Stripe\Price $price <p>Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. <a href="https://stripe.com/docs/api#products">Products</a> help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.</p><p>For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.</p><p>Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a>, <a href="https://stripe.com/docs/billing/invoices/create">create an invoice</a>, and more about <a href="https://stripe.com/docs/products-prices/overview">products and prices</a>.</p> |
| 18 | * @property int $quantity The <a href="https://stripe.com/docs/subscriptions/quantities">quantity</a> of the plan to which the customer should be subscribed. |
| 19 | * @property string $subscription The <code>subscription</code> this <code>subscription_item</code> belongs to. |
| 20 | * @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to this <code>subscription_item</code>. When set, the <code>default_tax_rates</code> on the subscription do not apply to this <code>subscription_item</code>. |
| 21 | */ |
| 22 | class SubscriptionItem extends ApiResource |
| 23 | { |
| 24 | const OBJECT_NAME = 'subscription_item'; |
| 25 | |
| 26 | use ApiOperations\All; |
| 27 | use ApiOperations\Create; |
| 28 | use ApiOperations\Delete; |
| 29 | use ApiOperations\NestedResource; |
| 30 | use ApiOperations\Retrieve; |
| 31 | use ApiOperations\Update; |
| 32 | |
| 33 | const PATH_USAGE_RECORDS = '/usage_records'; |
| 34 | |
| 35 | /** |
| 36 | * @param null|string $id the ID of the subscription item on which to create the usage record |
| 37 | * @param null|array $params |
| 38 | * @param null|array|string $opts |
| 39 | * |
| 40 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 41 | * |
| 42 | * @return \Stripe\UsageRecord |
| 43 | */ |
| 44 | public static function createUsageRecord($id, $params = null, $opts = null) |
| 45 | { |
| 46 | return self::_createNestedResource($id, static::PATH_USAGE_RECORDS, $params, $opts); |
| 47 | } |
| 48 | |
| 49 | /** |
| 50 | * @deprecated usageRecordSummaries is deprecated. Please use SubscriptionItem::allUsageRecordSummaries instead. |
| 51 | * |
| 52 | * @param null|array $params |
| 53 | * @param null|array|string $opts |
| 54 | * |
| 55 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 56 | * |
| 57 | * @return \Stripe\Collection the list of usage record summaries |
| 58 | */ |
| 59 | public function usageRecordSummaries($params = null, $opts = null) |
| 60 | { |
| 61 | $url = $this->instanceUrl() . '/usage_record_summaries'; |
| 62 | list($response, $opts) = $this->_request('get', $url, $params, $opts); |
| 63 | $obj = \Stripe\Util\Util::convertToStripeObject($response, $opts); |
| 64 | $obj->setLastResponse($response); |
| 65 | |
| 66 | return $obj; |
| 67 | } |
| 68 | |
| 69 | const PATH_USAGE_RECORD_SUMMARIES = '/usage_record_summaries'; |
| 70 | |
| 71 | /** |
| 72 | * @param string $id the ID of the subscription item on which to retrieve the usage record summaries |
| 73 | * @param null|array $params |
| 74 | * @param null|array|string $opts |
| 75 | * |
| 76 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 77 | * |
| 78 | * @return \Stripe\Collection<\Stripe\UsageRecordSummary> the list of usage record summaries |
| 79 | */ |
| 80 | public static function allUsageRecordSummaries($id, $params = null, $opts = null) |
| 81 | { |
| 82 | return self::_allNestedResources($id, static::PATH_USAGE_RECORD_SUMMARIES, $params, $opts); |
| 83 | } |
| 84 | } |
| 85 |