Skip to content

README.md

Latest commit

 

History

History
149 lines (96 loc) · 11.4 KB

README.md

File metadata and controls

149 lines (96 loc) · 11.4 KB
Raw

Disputes

(disputes)

Overview

Available Operations

list

List disputes.

Scopes: disputes:read disputes:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.disputes.list(organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737", page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
organization_id OptionalNullable[models.DisputesListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
order_id OptionalNullable[models.QueryParamOrderIDFilter] ➖ Filter by order ID.
status OptionalNullable[models.QueryParamStatusFilter] ➖ Filter by dispute status.
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.DisputeSortProperty] ➖ 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.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DisputesListResponse

Errors

Error Type Status Code Content Type
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*

get

Get a dispute by ID.

Scopes: disputes:read disputes:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.disputes.get(id="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The dispute ID.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.Dispute

Errors

Error Type Status Code Content Type
models.ResourceNotFound 404 application/json
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*

accept

Accept a dispute, conceding the chargeback.

Closes the dispute with the processor (settling it as lost) and records the merchant's decision on the dispute's support case.

Scopes: disputes:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.disputes.accept(id="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The dispute ID.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.Dispute

Errors

Error Type Status Code Content Type
models.ResourceNotFound 404 application/json
models.DisputeNotOpenError 409 application/json
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*