ApplicationFeeRefund.php

<?php

// File generated from our OpenAPI spec

namespace Stripe\StripeTaxForWooCommerce\SDK\lib;

/**
 * <code>Application Fee Refund</code> objects allow you to refund an application fee that
 * has previously been created but not yet refunded. Funds will be refunded to
 * the Stripe\StripeTaxForWooCommerce\SDK\lib account from which the fee was originally collected.
 *
 * Related guide: <a href="https://stripe.com/docs/connect/destination-charges#refunding-app-fee">Refunding application fees</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 Amount, in cents (or local equivalent).
 * @property null|string|\Stripe\StripeTaxForWooCommerce\SDK\lib\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
 * @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\StripeTaxForWooCommerce\SDK\lib\ApplicationFee $fee ID of the application fee that was refunded.
 * @property null|\Stripe\StripeTaxForWooCommerce\SDK\lib\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.
 */
class ApplicationFeeRefund extends ApiResource {

	const OBJECT_NAME = 'fee_refund';

	use ApiOperations\Update {
		save as protected _save;
	}

	/**
	 * @return string the API URL for this Stripe\StripeTaxForWooCommerce\SDK\lib refund
	 */
	public function instanceUrl() {
		$id  = $this['id'];
		$fee = $this['fee'];
		if ( ! $id ) {
			throw new Exception\UnexpectedValueException(
				'Could not determine which URL to request: ' .
				"class instance has invalid ID: {$id}",
				null
			);
		}
		$id  = Util\Util::utf8( $id );
		$fee = Util\Util::utf8( $fee );

		$base    = ApplicationFee::classUrl();
		$feeExtn = \urlencode( $fee );
		$extn    = \urlencode( $id );

		return "{$base}/{$feeExtn}/refunds/{$extn}";
	}

	/**
	 * @param null|array|string $opts
	 *
	 * @return ApplicationFeeRefund the saved refund
	 */
	public function save( $opts = null ) {
		return $this->_save( $opts );
	}
}