The Application Fee Refund object

Attributes

id string Unique identifier for the object.
amount integer Amount, in the smallest currency unit.
currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
fee string Expandable ID of the application fee that was refunded.
metadata nullable map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

More attributes

object string, value is "fee_refund"
balance _ transaction nullable string Expandable
created timestamp

{ "id": "fr_1MtJRpKbnvuxQXGuM6Ww0D24", "object": "fee_refund", "amount": 100, "balance_transaction": null, "created": 1680651573, "currency": "usd", "fee": "fee_1B73DOKbnvuxQXGuhY8Aw0TN", "metadata": {}}

Create an application fee refund

POST / v1 / application_fees /:id / refunds

Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can’t be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

Parameters

amount integer A positive integer, in the smallest currency unit, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns the Application Fee Refund object if the refund succeeded. Raises an error if the fee has already been refunded, or if an invalid fee identifier was provided.

Response

{ "id": "fr_1MtJRpKbnvuxQXGuM6Ww0D24", "object": "fee_refund", "amount": 100, "balance_transaction": null, "created": 1680651573, "currency": "usd", "fee": "fee_1B73DOKbnvuxQXGuhY8Aw0TN", "metadata": {}}

Update an application fee refund

POST / v1 / application_fees /:id / refunds /:id

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata as an argument.

Parameters

metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns the application fee refund object if the update succeeded. This call will raise an error if update parameters are invalid.

Response

{ "id": "fr_1MtJRpKbnvuxQXGuM6Ww0D24", "object": "fee_refund", "amount": 100, "balance_transaction": null, "created": 1680651573, "currency": "usd", "fee": "fee_1B73DOKbnvuxQXGuhY8Aw0TN", "metadata": { "order_id": "6735" }}