give / vendor / stripe / stripe-php / lib / CreditNote.php

CreditNote.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.4, at vendor/stripe/stripe-php/lib/CreditNote.php

112 lines 5.7 KB

Raw Download Zip

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