Get Dispute

GET

disputes

{id}

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.disputes.get(
    '00000000-0000-4000-8000-000000000000',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.disputes.get(
  "00000000-0000-4000-8000-000000000000",
);
console.log(response);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polar.sh/v1/disputes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polar.sh/v1/disputes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polar.sh/v1/disputes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/disputes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "id": "<string>",
  "status": "needs_response",
  "resolved": false,
  "closed": false,
  "amount": 1000,
  "tax_amount": 200,
  "currency": "usd",
  "reason": "fraudulent",
  "evidence_due_by": "2026-01-01T00:00:00.000000Z",
  "past_due": false,
  "order_id": "57107b74-8400-4d80-a2fc-54c2b4239cb3",
  "payment_id": "42b94870-36b9-4573-96b6-b90b1c99a353",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "metadata": {},
    "email_verified": true,
    "type": "individual",
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2026-01-01T00:00:00.000000Z",
    "first_user_event_at": "2026-01-01T00:00:00.000000Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
    "external_id": "usr_1337",
    "email": "[email protected]",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "case_id": "<string>"
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Scopes

disputes:read

pat

disputes:write

pat

disputes:read

oat

disputes:write

oat

Path Parameters

string<uuid4>

required

The dispute ID.

Response

Successful Response

Schema representing a dispute.

A dispute is a challenge raised by a customer or their bank regarding a payment.

created_at

string<date-time>

required

Creation timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

string<uuid4>

required

The ID of the object.

status

enum<string>

required

Status of the dispute. prevented means we issued a refund before the dispute was escalated, avoiding any fees.

Available options:

prevented,

early_warning,

needs_response,

under_review,

lost,

won

Examples:

"needs_response"

"prevented"

resolved

boolean

required

Whether the dispute has been resolved (won or lost).

Example:

false

closed

boolean

required

Whether the dispute is closed (prevented, won, or lost).

Example:

false

amount

integer

required

Amount in cents disputed.

Example:

1000

tax_amount

integer

required

Tax amount in cents disputed.

Example:

200

currency

string

required

Currency code of the dispute.

Example:

"usd"

reason

string | null

required

The reason for the dispute as reported by the card network (e.g. fraudulent, product_not_received). None until the processor reports it.

Example:

"fraudulent"

evidence_due_by

string<date-time> | null

required

Deadline to submit evidence in response to the dispute. None when no response is required.

Example:

"2026-01-01T00:00:00.000000Z"

past_due

boolean

required

Whether the evidence submission deadline has passed.

Example:

false

order_id

string<uuid4>

required

The ID of the order associated with the dispute.

Example:

"57107b74-8400-4d80-a2fc-54c2b4239cb3"

payment_id

string<uuid4>

required

The ID of the payment associated with the dispute.

Example:

"42b94870-36b9-4573-96b6-b90b1c99a353"

customer

DisputeCustomer · object

required

The customer who was charged for the disputed payment.

Show child attributes

case_id

string<uuid4> | null

required

The ID of the support case for this dispute, if one was opened.

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.disputes.get(
    '00000000-0000-4000-8000-000000000000',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.disputes.get(
  "00000000-0000-4000-8000-000000000000",
);
console.log(response);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polar.sh/v1/disputes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polar.sh/v1/disputes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polar.sh/v1/disputes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/disputes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "id": "<string>",
  "status": "needs_response",
  "resolved": false,
  "closed": false,
  "amount": 1000,
  "tax_amount": 200,
  "currency": "usd",
  "reason": "fraudulent",
  "evidence_due_by": "2026-01-01T00:00:00.000000Z",
  "past_due": false,
  "order_id": "57107b74-8400-4d80-a2fc-54c2b4239cb3",
  "payment_id": "42b94870-36b9-4573-96b6-b90b1c99a353",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "metadata": {},
    "email_verified": true,
    "type": "individual",
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2026-01-01T00:00:00.000000Z",
    "first_user_event_at": "2026-01-01T00:00:00.000000Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
    "external_id": "usr_1337",
    "email": "[email protected]",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "case_id": "<string>"
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Authorizations

Scopes

Path Parameters

Response