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

Update an application fee refund

Updates an application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This endpoint only accepts metadata as an argument.

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

2 parameters · 2 body fields
feestringrequired

The unique identifier of the application fee.

idstringrequired

The unique identifier of the refund to update.

Refund metadata update.

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 updated application fee refund object with the new metadata applied.
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

fee and id must identify an existing application fee and refund respectively. Only metadata can be updated on a refund.