ApiOperations
6 years ago
Checkout
6 years ago
Error
6 years ago
HttpClient
6 years ago
Issuing
6 years ago
Radar
6 years ago
Reporting
6 years ago
Sigma
6 years ago
Terminal
6 years ago
Util
6 years ago
Account.php
6 years ago
AccountLink.php
6 years ago
AlipayAccount.php
6 years ago
ApiRequestor.php
6 years ago
ApiResource.php
6 years ago
ApiResponse.php
6 years ago
ApplePayDomain.php
6 years ago
ApplicationFee.php
6 years ago
ApplicationFeeRefund.php
6 years ago
Balance.php
6 years ago
BalanceTransaction.php
6 years ago
BankAccount.php
6 years ago
BitcoinReceiver.php
6 years ago
BitcoinTransaction.php
6 years ago
Capability.php
6 years ago
Card.php
6 years ago
Charge.php
6 years ago
Collection.php
6 years ago
CountrySpec.php
6 years ago
Coupon.php
6 years ago
CreditNote.php
6 years ago
Customer.php
6 years ago
CustomerBalanceTransaction.php
6 years ago
Discount.php
6 years ago
Dispute.php
6 years ago
EphemeralKey.php
6 years ago
Event.php
6 years ago
ExchangeRate.php
6 years ago
File.php
6 years ago
FileLink.php
6 years ago
FileUpload.php
6 years ago
Invoice.php
6 years ago
InvoiceItem.php
6 years ago
InvoiceLineItem.php
6 years ago
IssuerFraudRecord.php
6 years ago
LoginLink.php
6 years ago
OAuth.php
6 years ago
Order.php
6 years ago
OrderItem.php
6 years ago
OrderReturn.php
6 years ago
PaymentIntent.php
6 years ago
PaymentMethod.php
6 years ago
Payout.php
6 years ago
Person.php
6 years ago
Plan.php
6 years ago
Product.php
6 years ago
Recipient.php
6 years ago
RecipientTransfer.php
6 years ago
Refund.php
6 years ago
RequestTelemetry.php
6 years ago
Review.php
6 years ago
SKU.php
6 years ago
SetupIntent.php
6 years ago
SingletonApiResource.php
6 years ago
Source.php
6 years ago
SourceTransaction.php
6 years ago
Stripe.php
6 years ago
StripeObject.php
6 years ago
Subscription.php
6 years ago
SubscriptionItem.php
6 years ago
SubscriptionSchedule.php
6 years ago
TaxId.php
6 years ago
TaxRate.php
6 years ago
ThreeDSecure.php
6 years ago
Token.php
6 years ago
Topup.php
6 years ago
Transfer.php
6 years ago
TransferReversal.php
6 years ago
UsageRecord.php
6 years ago
UsageRecordSummary.php
6 years ago
Webhook.php
6 years ago
WebhookEndpoint.php
6 years ago
WebhookSignature.php
6 years ago
Invoice.php
203 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Stripe; |
| 4 | |
| 5 | /** |
| 6 | * Class Invoice |
| 7 | * |
| 8 | * @property string $id |
| 9 | * @property string $object |
| 10 | * @property string $account_country |
| 11 | * @property string $account_name |
| 12 | * @property int $amount_due |
| 13 | * @property int $amount_paid |
| 14 | * @property int $amount_remaining |
| 15 | * @property int $application_fee_amount |
| 16 | * @property int $attempt_count |
| 17 | * @property bool $attempted |
| 18 | * @property bool $auto_advance |
| 19 | * @property string $billing |
| 20 | * @property string $billing_reason |
| 21 | * @property string $charge |
| 22 | * @property string $collection_method |
| 23 | * @property int $created |
| 24 | * @property string $currency |
| 25 | * @property array $custom_fields |
| 26 | * @property string $customer |
| 27 | * @property mixed $customer_address |
| 28 | * @property string $customer_email |
| 29 | * @property string $customer_name |
| 30 | * @property string $customer_phone |
| 31 | * @property mixed $customer_shipping |
| 32 | * @property string $customer_tax_exempt |
| 33 | * @property array $customer_tax_ids |
| 34 | * @property string $default_payment_method |
| 35 | * @property string $default_source |
| 36 | * @property array $default_tax_rates |
| 37 | * @property string $description |
| 38 | * @property Discount $discount |
| 39 | * @property int $due_date |
| 40 | * @property int $ending_balance |
| 41 | * @property string $footer |
| 42 | * @property string $hosted_invoice_url |
| 43 | * @property string $invoice_pdf |
| 44 | * @property Collection $lines |
| 45 | * @property bool $livemode |
| 46 | * @property StripeObject $metadata |
| 47 | * @property int $next_payment_attempt |
| 48 | * @property string $number |
| 49 | * @property bool $paid |
| 50 | * @property string $payment_intent |
| 51 | * @property int $period_end |
| 52 | * @property int $period_start |
| 53 | * @property int $post_payment_credit_notes_amount |
| 54 | * @property int $pre_payment_credit_notes_amount |
| 55 | * @property string $receipt_number |
| 56 | * @property int $starting_balance |
| 57 | * @property string $statement_descriptor |
| 58 | * @property string $status |
| 59 | * @property mixed $status_transitions |
| 60 | * @property string $subscription |
| 61 | * @property int $subscription_proration_date |
| 62 | * @property int $subtotal |
| 63 | * @property int $tax |
| 64 | * @property mixed $threshold_reason |
| 65 | * @property int $total |
| 66 | * @property array $total_tax_amounts |
| 67 | * @property int $webhooks_delivered_at |
| 68 | * |
| 69 | * @package Stripe |
| 70 | */ |
| 71 | class Invoice extends ApiResource |
| 72 | { |
| 73 | const OBJECT_NAME = "invoice"; |
| 74 | |
| 75 | use ApiOperations\All; |
| 76 | use ApiOperations\Create; |
| 77 | use ApiOperations\Delete; |
| 78 | use ApiOperations\Retrieve; |
| 79 | use ApiOperations\Update; |
| 80 | |
| 81 | /** |
| 82 | * Possible string representations of the billing reason. |
| 83 | * @link https://stripe.com/docs/api/invoices/object#invoice_object-billing_reason |
| 84 | */ |
| 85 | const BILLING_REASON_MANUAL = 'manual'; |
| 86 | const BILLING_REASON_SUBSCRIPTION = 'subscription'; |
| 87 | const BILLING_REASON_SUBSCRIPTION_CREATE = 'subscription_create'; |
| 88 | const BILLING_REASON_SUBSCRIPTION_CYCLE = 'subscription_cycle'; |
| 89 | const BILLING_REASON_SUBSCRIPTION_THRESHOLD = 'subscription_threshold'; |
| 90 | const BILLING_REASON_SUBSCRIPTION_UPDATE = 'subscription_update'; |
| 91 | const BILLING_REASON_UPCOMING = 'upcoming'; |
| 92 | |
| 93 | /** |
| 94 | * Possible string representations of the `collection_method` property. |
| 95 | * @link https://stripe.com/docs/api/invoices/object#invoice_object-collection_method |
| 96 | */ |
| 97 | const COLLECTION_METHOD_CHARGE_AUTOMATICALLY = 'charge_automatically'; |
| 98 | const COLLECTION_METHOD_SEND_INVOICE = 'send_invoice'; |
| 99 | |
| 100 | /** |
| 101 | * Possible string representations of the invoice status. |
| 102 | * @link https://stripe.com/docs/api/invoices/object#invoice_object-status |
| 103 | */ |
| 104 | const STATUS_DRAFT = 'draft'; |
| 105 | const STATUS_OPEN = 'open'; |
| 106 | const STATUS_PAID = 'paid'; |
| 107 | const STATUS_UNCOLLECTIBLE = 'uncollectible'; |
| 108 | const STATUS_VOID = 'void'; |
| 109 | |
| 110 | /** |
| 111 | * Possible string representations of the `billing` property. |
| 112 | * @deprecated Use `collection_method` instead. |
| 113 | * @link https://stripe.com/docs/api/invoices/object#invoice_object-billing |
| 114 | */ |
| 115 | const BILLING_CHARGE_AUTOMATICALLY = 'charge_automatically'; |
| 116 | const BILLING_SEND_INVOICE = 'send_invoice'; |
| 117 | |
| 118 | /** |
| 119 | * @param array|null $params |
| 120 | * @param array|string|null $opts |
| 121 | * |
| 122 | * @return Invoice The finalized invoice. |
| 123 | */ |
| 124 | public function finalizeInvoice($params = null, $opts = null) |
| 125 | { |
| 126 | $url = $this->instanceUrl() . '/finalize'; |
| 127 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 128 | $this->refreshFrom($response, $opts); |
| 129 | return $this; |
| 130 | } |
| 131 | |
| 132 | /** |
| 133 | * @param array|null $params |
| 134 | * @param array|string|null $opts |
| 135 | * |
| 136 | * @return Invoice The uncollectible invoice. |
| 137 | */ |
| 138 | public function markUncollectible($params = null, $opts = null) |
| 139 | { |
| 140 | $url = $this->instanceUrl() . '/mark_uncollectible'; |
| 141 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 142 | $this->refreshFrom($response, $opts); |
| 143 | return $this; |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * @param array|null $params |
| 148 | * @param array|string|null $opts |
| 149 | * |
| 150 | * @return Invoice The paid invoice. |
| 151 | */ |
| 152 | public function pay($params = null, $opts = null) |
| 153 | { |
| 154 | $url = $this->instanceUrl() . '/pay'; |
| 155 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 156 | $this->refreshFrom($response, $opts); |
| 157 | return $this; |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * @param array|null $params |
| 162 | * @param array|string|null $opts |
| 163 | * |
| 164 | * @return Invoice The sent invoice. |
| 165 | */ |
| 166 | public function sendInvoice($params = null, $opts = null) |
| 167 | { |
| 168 | $url = $this->instanceUrl() . '/send'; |
| 169 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 170 | $this->refreshFrom($response, $opts); |
| 171 | return $this; |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * @param array|null $params |
| 176 | * @param array|string|null $opts |
| 177 | * |
| 178 | * @return Invoice The upcoming invoice. |
| 179 | */ |
| 180 | public static function upcoming($params = null, $opts = null) |
| 181 | { |
| 182 | $url = static::classUrl() . '/upcoming'; |
| 183 | list($response, $opts) = static::_staticRequest('get', $url, $params, $opts); |
| 184 | $obj = Util\Util::convertToStripeObject($response->json, $opts); |
| 185 | $obj->setLastResponse($response); |
| 186 | return $obj; |
| 187 | } |
| 188 | |
| 189 | /** |
| 190 | * @param array|null $params |
| 191 | * @param array|string|null $opts |
| 192 | * |
| 193 | * @return Invoice The voided invoice. |
| 194 | */ |
| 195 | public function voidInvoice($params = null, $opts = null) |
| 196 | { |
| 197 | $url = $this->instanceUrl() . '/void'; |
| 198 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 199 | $this->refreshFrom($response, $opts); |
| 200 | return $this; |
| 201 | } |
| 202 | } |
| 203 |