You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit
and starting_
parameters to page through additional refunds.
Parameters
No parameters.
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of up to limit
refunds, starting after starting_
. Each entry in the array is a separate application fee refund object. If no more refunds are available, the resulting array will be empty. If you provide a non-existent application fee ID, this call raises an error.
{ "object": "list", "url": "/v1/application_fees/fr_1MtJRpKbnvuxQXGuM6Ww0D24/refunds", "has_more": false, "data": [ { "id": "fr_1MtJRpKbnvuxQXGuM6Ww0D24", "object": "fee_refund", "amount": 100, "balance_transaction": null, "created": 1680651573, "currency": "usd", "fee": "fee_1B73DOKbnvuxQXGuhY8Aw0TN", "metadata": {} } ]}