List Refunds

List refunds.

Scopes: refunds:read refunds:write

GET /v1/refunds

Go (SDK)

Go

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Refunds.List(ctx, operations.RefundsListRequest{
        OrganizationID: polargo.Pointer(operations.CreateRefundsListQueryParamOrganizationIDFilterStr(
            "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceRefund != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

200

{
  "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,
      "dispute": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "status": "prevented",
        "resolved": true,
        "closed": true,
        "amount": 123,
        "tax_amount": 123,
        "currency": "<string>",
        "order_id": "<string>",
        "payment_id": "<string>"
      }
    }
  ],
  "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 · string<uuid4> string<uuid4>[]

Filter by refund ID. The refund ID.

organization_id · string<uuid4> string<uuid4>[]

Filter by organization ID. The organization ID.

Example:

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

order_id · string<uuid4> string<uuid4>[]

Filter by order ID. The order ID.

subscription_id · string<uuid4> string<uuid4>[]

Filter by subscription ID. The subscription ID.

customer_id · string<uuid4> string<uuid4>[]

Filter by customer ID. The customer ID.

external_customer_id · string string[]

Filter by customer external ID. The customer external ID.

succeeded · boolean | null

Filter by succeeded.

page · integer · default: 1

Page number, defaults to 1.

limit · integer · default: 10

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

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.

Available options: created_at, -created_at, amount, -amount

Response

200

application/json

Successful Response

items · Refund · object[] · required

Show child attributes

pagination · Pagination · object · required

Show child attributes