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
CreditNote.php
112 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * Issue a credit note to adjust an invoice's amount after the invoice is |
| 9 | * finalized. |
| 10 | * |
| 11 | * Related guide: <a |
| 12 | * href="https://stripe.com/docs/billing/invoices/credit-notes">Credit Notes</a>. |
| 13 | * |
| 14 | * @property string $id Unique identifier for the object. |
| 15 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 16 | * @property int $amount The integer amount in %s representing the total amount of the credit note, including tax. |
| 17 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 18 | * @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>. |
| 19 | * @property string|\Stripe\Customer $customer ID of the customer. |
| 20 | * @property null|string|\Stripe\CustomerBalanceTransaction $customer_balance_transaction Customer balance transaction related to this credit note. |
| 21 | * @property int $discount_amount The integer amount in %s representing the total amount of discount that was credited. |
| 22 | * @property \Stripe\StripeObject[] $discount_amounts The aggregate amounts calculated per discount for all line items. |
| 23 | * @property string|\Stripe\Invoice $invoice ID of the invoice. |
| 24 | * @property \Stripe\Collection<\Stripe\CreditNoteLineItem> $lines Line items that make up the credit note |
| 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|string $memo Customer-facing text that appears on the credit note PDF. |
| 27 | * @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. |
| 28 | * @property string $number A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. |
| 29 | * @property null|int $out_of_band_amount Amount that was credited outside of Stripe. |
| 30 | * @property string $pdf The link to download the PDF of the credit note. |
| 31 | * @property null|string $reason Reason for issuing this credit note, one of <code>duplicate</code>, <code>fraudulent</code>, <code>order_change</code>, or <code>product_unsatisfactory</code> |
| 32 | * @property null|string|\Stripe\Refund $refund Refund related to this credit note. |
| 33 | * @property string $status Status of this credit note, one of <code>issued</code> or <code>void</code>. Learn more about <a href="https://stripe.com/docs/billing/invoices/credit-notes#voiding">voiding credit notes</a>. |
| 34 | * @property int $subtotal The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts. |
| 35 | * @property \Stripe\StripeObject[] $tax_amounts The aggregate amounts calculated per tax rate for all line items. |
| 36 | * @property int $total The integer amount in %s representing the total amount of the credit note, including tax and all discount. |
| 37 | * @property string $type Type of this credit note, one of <code>pre_payment</code> or <code>post_payment</code>. A <code>pre_payment</code> credit note means it was issued when the invoice was open. A <code>post_payment</code> credit note means it was issued when the invoice was paid. |
| 38 | * @property null|int $voided_at The time that the credit note was voided. |
| 39 | */ |
| 40 | class CreditNote extends ApiResource |
| 41 | { |
| 42 | const OBJECT_NAME = 'credit_note'; |
| 43 | |
| 44 | use ApiOperations\All; |
| 45 | use ApiOperations\Create; |
| 46 | use ApiOperations\NestedResource; |
| 47 | use ApiOperations\Retrieve; |
| 48 | use ApiOperations\Update; |
| 49 | |
| 50 | const REASON_DUPLICATE = 'duplicate'; |
| 51 | const REASON_FRAUDULENT = 'fraudulent'; |
| 52 | const REASON_ORDER_CHANGE = 'order_change'; |
| 53 | const REASON_PRODUCT_UNSATISFACTORY = 'product_unsatisfactory'; |
| 54 | |
| 55 | const STATUS_ISSUED = 'issued'; |
| 56 | const STATUS_VOID = 'void'; |
| 57 | |
| 58 | const TYPE_POST_PAYMENT = 'post_payment'; |
| 59 | const TYPE_PRE_PAYMENT = 'pre_payment'; |
| 60 | |
| 61 | /** |
| 62 | * @param null|array $params |
| 63 | * @param null|array|string $opts |
| 64 | * |
| 65 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 66 | * |
| 67 | * @return \Stripe\CreditNote the previewed credit note |
| 68 | */ |
| 69 | public static function preview($params = null, $opts = null) |
| 70 | { |
| 71 | $url = static::classUrl() . '/preview'; |
| 72 | list($response, $opts) = static::_staticRequest('get', $url, $params, $opts); |
| 73 | $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 74 | $obj->setLastResponse($response); |
| 75 | |
| 76 | return $obj; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * @param null|array $params |
| 81 | * @param null|array|string $opts |
| 82 | * |
| 83 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 84 | * |
| 85 | * @return \Stripe\CreditNote the voided credit note |
| 86 | */ |
| 87 | public function voidCreditNote($params = null, $opts = null) |
| 88 | { |
| 89 | $url = $this->instanceUrl() . '/void'; |
| 90 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 91 | $this->refreshFrom($response, $opts); |
| 92 | |
| 93 | return $this; |
| 94 | } |
| 95 | |
| 96 | const PATH_LINES = '/lines'; |
| 97 | |
| 98 | /** |
| 99 | * @param string $id the ID of the credit note on which to retrieve the credit note line items |
| 100 | * @param null|array $params |
| 101 | * @param null|array|string $opts |
| 102 | * |
| 103 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 104 | * |
| 105 | * @return \Stripe\Collection<\Stripe\CreditNoteLineItem> the list of credit note line items |
| 106 | */ |
| 107 | public static function allLines($id, $params = null, $opts = null) |
| 108 | { |
| 109 | return self::_allNestedResources($id, static::PATH_LINES, $params, $opts); |
| 110 | } |
| 111 | } |
| 112 |