GET
/
v1
/
refunds
/
Typescript (SDK)
import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.refunds.list({
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "metadata": {},
      "status": "pending",
      "reason": "duplicate",
      "amount": 123,
      "tax_amount": 123,
      "currency": "<string>",
      "organization_id": "<string>",
      "order_id": "<string>",
      "subscription_id": "<string>",
      "customer_id": "<string>",
      "revoke_benefits": true
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Query Parameters

​
id

Filter by refund ID. The refund ID.

​
organization_id

Filter by organization ID. The organization ID.

Examples:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

​
order_id

Filter by order ID. The order ID.

​
subscription_id

Filter by subscription ID. The subscription ID.

​
customer_id

Filter by customer ID. The customer ID.

​
succeeded
boolean | null

Filter by succeeded.

​
page
integer
default:1

Page number, defaults to 1.

Required range: x > 0
​
limit
integer
default:10

Size of a page, defaults to 10. Maximum is 100.

Required range: x > 0
​
sorting
enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

Successful Response

​
items
Refund · object[]
required
​
pagination
object
required