PATH:
home
/
lab2454c
/
tripvare.com
/
vendor
/
stripe
/
stripe-php
/
lib
<?php // File generated from our OpenAPI spec namespace Stripe; /** * Issue a credit note to adjust an invoice's amount after the invoice is * finalized. * * Related guide: <a * href="https://stripe.com/docs/billing/invoices/credit-notes">Credit Notes</a>. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property int $amount The integer amount in %s representing the total amount of the credit note, including tax. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @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>. * @property string|\Stripe\Customer $customer ID of the customer. * @property null|string|\Stripe\CustomerBalanceTransaction $customer_balance_transaction Customer balance transaction related to this credit note. * @property int $discount_amount The integer amount in %s representing the total amount of discount that was credited. * @property \Stripe\StripeObject[] $discount_amounts The aggregate amounts calculated per discount for all line items. * @property string|\Stripe\Invoice $invoice ID of the invoice. * @property \Stripe\Collection $lines Line items that make up the credit note * @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. * @property null|string $memo Customer-facing text that appears on the credit note PDF. * @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. * @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. * @property null|int $out_of_band_amount Amount that was credited outside of Stripe. * @property string $pdf The link to download the PDF of the credit note. * @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> * @property null|string|\Stripe\Refund $refund Refund related to this credit note. * @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>. * @property int $subtotal The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts. * @property \Stripe\StripeObject[] $tax_amounts The aggregate amounts calculated per tax rate for all line items. * @property int $total The integer amount in %s representing the total amount of the credit note, including tax and all discount. * @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. * @property null|int $voided_at The time that the credit note was voided. */ class CreditNote extends ApiResource { const OBJECT_NAME = 'credit_note'; use ApiOperations\All; use ApiOperations\Create; use ApiOperations\NestedResource; use ApiOperations\Retrieve; use ApiOperations\Update; const REASON_DUPLICATE = 'duplicate'; const REASON_FRAUDULENT = 'fraudulent'; const REASON_ORDER_CHANGE = 'order_change'; const REASON_PRODUCT_UNSATISFACTORY = 'product_unsatisfactory'; const STATUS_ISSUED = 'issued'; const STATUS_VOID = 'void'; const TYPE_POST_PAYMENT = 'post_payment'; const TYPE_PRE_PAYMENT = 'pre_payment'; /** * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails * * @return \Stripe\CreditNote the previewed credit note */ public static function preview($params = null, $opts = null) { $url = static::classUrl() . '/preview'; list($response, $opts) = static::_staticRequest('get', $url, $params, $opts); $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; } /** * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails * * @return \Stripe\CreditNote the voided credit note */ public function voidCreditNote($params = null, $opts = null) { $url = $this->instanceUrl() . '/void'; list($response, $opts) = $this->_request('post', $url, $params, $opts); $this->refreshFrom($response, $opts); return $this; } const PATH_LINES = '/lines'; /** * @param string $id the ID of the credit note on which to retrieve the credit note line items * @param null|array $params * @param null|array|string $opts * * @throws \Stripe\Exception\ApiErrorException if the request fails * * @return \Stripe\Collection the list of credit note line items */ public static function allLines($id, $params = null, $opts = null) { return self::_allNestedResources($id, static::PATH_LINES, $params, $opts); } }
[-] ThreeDSecure.php
[edit]
[-] WebhookEndpoint.php
[edit]
[+]
Terminal
[-] ApplicationFeeRefund.php
[edit]
[-] WebhookSignature.php
[edit]
[-] OrderItem.php
[edit]
[-] PaymentIntent.php
[edit]
[-] StripeClientInterface.php
[edit]
[-] AlipayAccount.php
[edit]
[-] InvoiceItem.php
[edit]
[-] TransferReversal.php
[edit]
[-] StripeClient.php
[edit]
[+]
Sigma
[-] Coupon.php
[edit]
[-] File.php
[edit]
[-] BaseStripeClient.php
[edit]
[-] OAuth.php
[edit]
[-] Review.php
[edit]
[-] FileLink.php
[edit]
[-] LoginLink.php
[edit]
[-] Charge.php
[edit]
[+]
..
[-] Discount.php
[edit]
[-] Balance.php
[edit]
[+]
Exception
[-] CustomerBalanceTransaction.php
[edit]
[-] Payout.php
[edit]
[-] TaxRate.php
[edit]
[-] ApplicationFee.php
[edit]
[-] SubscriptionSchedule.php
[edit]
[-] ApplePayDomain.php
[edit]
[-] OAuthErrorObject.php
[edit]
[-] SetupIntent.php
[edit]
[-] ApiResource.php
[edit]
[-] Plan.php
[edit]
[-] Refund.php
[edit]
[-] InvoiceLineItem.php
[edit]
[-] CountrySpec.php
[edit]
[-] EphemeralKey.php
[edit]
[-] BitcoinTransaction.php
[edit]
[-] Card.php
[edit]
[-] Quote.php
[edit]
[-] SourceTransaction.php
[edit]
[-] Order.php
[edit]
[-] TaxId.php
[edit]
[-] Subscription.php
[edit]
[-] Account.php
[edit]
[-] AccountLink.php
[edit]
[-] Price.php
[edit]
[+]
Issuing
[-] Token.php
[edit]
[-] SetupAttempt.php
[edit]
[-] Stripe.php
[edit]
[-] Customer.php
[edit]
[-] Event.php
[edit]
[-] RequestTelemetry.php
[edit]
[-] StripeStreamingClientInterface.php
[edit]
[-] ExchangeRate.php
[edit]
[-] PromotionCode.php
[edit]
[+]
Checkout
[+]
ApiOperations
[-] Mandate.php
[edit]
[-] Person.php
[edit]
[-] ApiResponse.php
[edit]
[-] BaseStripeClientInterface.php
[edit]
[-] Transfer.php
[edit]
[+]
Radar
[-] SKU.php
[edit]
[-] RecipientTransfer.php
[edit]
[-] Recipient.php
[edit]
[+]
HttpClient
[+]
BillingPortal
[-] BalanceTransaction.php
[edit]
[-] ApiRequestor.php
[edit]
[-] Product.php
[edit]
[-] LineItem.php
[edit]
[+]
Reporting
[-] Capability.php
[edit]
[-] OrderReturn.php
[edit]
[-] CreditNote.php
[edit]
[-] UsageRecordSummary.php
[edit]
[-] PaymentMethod.php
[edit]
[-] UsageRecord.php
[edit]
[+]
Util
[-] Invoice.php
[edit]
[-] BankAccount.php
[edit]
[-] ErrorObject.php
[edit]
[-] Source.php
[edit]
[-] Topup.php
[edit]
[+]
Service
[-] Dispute.php
[edit]
[-] SubscriptionItem.php
[edit]
[-] SingletonApiResource.php
[edit]
[-] TaxCode.php
[edit]
[-] StripeObject.php
[edit]
[-] Webhook.php
[edit]
[-] CreditNoteLineItem.php
[edit]
[-] BitcoinReceiver.php
[edit]
[-] Collection.php
[edit]
[+]
Identity