Swagger Petstore - OpenAPI 3.0
POST/v1/application_fees/{id}/refunds

Create an application fee refund

Creates a refund for an application fee that has previously been collected but not yet refunded. Funds are returned to the Stripe account from which the fee was originally collected. You can refund only part of a fee and perform multiple partial refunds until the entire fee is refunded.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
idstringrequired

The unique identifier of the application fee to refund.

Refund parameters. All fields are optional.

amountintegeroptional

A positive integer, in cents (or local equivalent), representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.

expandarray<string>optional

Specifies which fields in the response should be expanded.

metadataobjectoptional

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.

2 status codes
200Returns the created application fee refund object with the refunded amount, balance transaction, and metadata.
amountintegerrequired

Amount, in cents (or local equivalent).

balance_transactionstringoptional

Balance transaction that describes the impact on your account balance.

createdintegerrequired

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystringrequired

Three-letter ISO currency code, in lowercase. Must be a supported currency.

feestringrequired

ID of the application fee that was refunded.

idstringrequired

Unique identifier for the object.

metadataobjectoptional

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.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:fee_refund
defaultError response.
errorobjectrequired

Error handling

id must identify an existing application fee. If amount is provided, it must be a positive integer in cents and cannot exceed the remaining unrefunded balance. Attempting to refund an already-fully-refunded fee or more than the remaining balance is rejected.