77 lines
2.2 KiB
PHP
Executable File
77 lines
2.2 KiB
PHP
Executable File
<?php
|
|
|
|
namespace Stripe;
|
|
|
|
/**
|
|
* Class CreditNote
|
|
*
|
|
* @property string $id
|
|
* @property string $object
|
|
* @property int $amount
|
|
* @property int $created
|
|
* @property string $currency
|
|
* @property string $customer
|
|
* @property string|null $customer_balance_transaction
|
|
* @property string $invoice
|
|
* @property bool $livemode
|
|
* @property string|null $memo
|
|
* @property \Stripe\StripeObject $metadata
|
|
* @property string $number
|
|
* @property string $pdf
|
|
* @property string|null $reason
|
|
* @property string|null $refund
|
|
* @property string $status
|
|
* @property string $type
|
|
* @property int|null $voided_at
|
|
*
|
|
* @package Stripe
|
|
*/
|
|
class CreditNote extends ApiResource
|
|
{
|
|
const OBJECT_NAME = 'credit_note';
|
|
|
|
use ApiOperations\All;
|
|
use ApiOperations\Create;
|
|
use ApiOperations\Retrieve;
|
|
use ApiOperations\Update;
|
|
|
|
/**
|
|
* Possible string representations of the credit note reason.
|
|
* @link https://stripe.com/docs/api/credit_notes/object#credit_note_object-reason
|
|
*/
|
|
const REASON_DUPLICATE = 'duplicate';
|
|
const REASON_FRAUDULENT = 'fraudulent';
|
|
const REASON_ORDER_CHANGE = 'order_change';
|
|
const REASON_PRODUCT_UNSATISFACTORY = 'product_unsatisfactory';
|
|
|
|
/**
|
|
* Possible string representations of the credit note status.
|
|
* @link https://stripe.com/docs/api/credit_notes/object#credit_note_object-status
|
|
*/
|
|
const STATUS_ISSUED = 'issued';
|
|
const STATUS_VOID = 'void';
|
|
|
|
/**
|
|
* Possible string representations of the credit note type.
|
|
* @link https://stripe.com/docs/api/credit_notes/object#credit_note_object-status
|
|
*/
|
|
const TYPE_POST_PAYMENT = 'post_payment';
|
|
const TYPE_PRE_PAYMENT = 'pre_payment';
|
|
|
|
/**
|
|
* @param array|null $params
|
|
* @param array|string|null $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return 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;
|
|
}
|
|
}
|