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
Order.php
82 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * Order objects are created to handle end customers' purchases of previously |
| 9 | * defined <a href="https://stripe.com/docs/api#products">products</a>. You can |
| 10 | * create, retrieve, and pay individual orders, as well as list all orders. Orders |
| 11 | * are identified by a unique, random ID. |
| 12 | * |
| 13 | * Related guide: <a href="https://stripe.com/docs/orders-legacy">Tax, Shipping, |
| 14 | * and Inventory</a>. |
| 15 | * |
| 16 | * @property string $id Unique identifier for the object. |
| 17 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 18 | * @property int $amount A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. |
| 19 | * @property null|int $amount_returned The total amount that was returned to the customer. |
| 20 | * @property null|string $application ID of the Connect Application that created the order. |
| 21 | * @property null|int $application_fee A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. |
| 22 | * @property null|string|\Stripe\Charge $charge The ID of the payment used to pay for the order. Present if the order status is <code>paid</code>, <code>fulfilled</code>, or <code>refunded</code>. |
| 23 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 24 | * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>. |
| 25 | * @property null|string|\Stripe\Customer $customer The customer used for the order. |
| 26 | * @property null|string $email The email address of the customer placing the order. |
| 27 | * @property string $external_coupon_code External coupon code to load for this order. |
| 28 | * @property \Stripe\OrderItem[] $items List of items constituting the order. An order can have up to 25 items. |
| 29 | * @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. |
| 30 | * @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. |
| 31 | * @property null|\Stripe\Collection<\Stripe\OrderReturn> $returns A list of returns that have taken place for this order. |
| 32 | * @property null|string $selected_shipping_method The shipping method that is currently selected for this order, if any. If present, it is equal to one of the <code>id</code>s of shipping methods in the <code>shipping_methods</code> array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. |
| 33 | * @property null|\Stripe\StripeObject $shipping The shipping address for the order. Present if the order is for goods to be shipped. |
| 34 | * @property null|\Stripe\StripeObject[] $shipping_methods A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. |
| 35 | * @property string $status Current order status. One of <code>created</code>, <code>paid</code>, <code>canceled</code>, <code>fulfilled</code>, or <code>returned</code>. More details in the <a href="https://stripe.com/docs/orders/guide#understanding-order-statuses">Orders Guide</a>. |
| 36 | * @property null|\Stripe\StripeObject $status_transitions The timestamps at which the order status was updated. |
| 37 | * @property null|int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch. |
| 38 | * @property string $upstream_id The user's order ID if it is different from the Stripe order ID. |
| 39 | */ |
| 40 | class Order extends ApiResource |
| 41 | { |
| 42 | const OBJECT_NAME = 'order'; |
| 43 | |
| 44 | use ApiOperations\All; |
| 45 | use ApiOperations\Create; |
| 46 | use ApiOperations\Retrieve; |
| 47 | use ApiOperations\Update; |
| 48 | |
| 49 | /** |
| 50 | * @param null|array $params |
| 51 | * @param null|array|string $opts |
| 52 | * |
| 53 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 54 | * |
| 55 | * @return \Stripe\OrderReturn the newly created return |
| 56 | */ |
| 57 | public function returnOrder($params = null, $opts = null) |
| 58 | { |
| 59 | $url = $this->instanceUrl() . '/returns'; |
| 60 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 61 | |
| 62 | return Util\Util::convertToStripeObject($response, $opts); |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * @param null|array $params |
| 67 | * @param null|array|string $opts |
| 68 | * |
| 69 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 70 | * |
| 71 | * @return \Stripe\Order the paid order |
| 72 | */ |
| 73 | public function pay($params = null, $opts = null) |
| 74 | { |
| 75 | $url = $this->instanceUrl() . '/pay'; |
| 76 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 77 | $this->refreshFrom($response, $opts); |
| 78 | |
| 79 | return $this; |
| 80 | } |
| 81 | } |
| 82 |