Skip to content

README.md

Latest commit

 

History

History
104 lines (68 loc) · 11 KB

README.md

File metadata and controls

104 lines (68 loc) · 11 KB

Payments

(payments)

Overview

Available Operations

  • list - List Payments
  • get - Get Payment

list

List payments.

Scopes: payments:read

Example Usage

from polar_sdk import Polar


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

    res = polar.payments.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.PaymentsListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
checkout_id OptionalNullable[models.PaymentsListQueryParamCheckoutIDFilter] ➖ Filter by checkout ID.
order_id OptionalNullable[models.PaymentsListQueryParamOrderIDFilter] ➖ Filter by order ID.
status OptionalNullable[models.PaymentsListQueryParamStatusFilter] ➖ Filter by payment status.
method OptionalNullable[models.MethodFilter] ➖ Filter by payment method.
customer_email OptionalNullable[models.CustomerEmailFilter] ➖ Filter by customer email.
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.PaymentSortProperty] ➖ 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.PaymentsListResponse

Errors

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

get

Get a payment by ID.

Scopes: payments:read

Example Usage

from polar_sdk import Polar


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

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

    # Handle response
    print(res)

Parameters

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

Response

models.Payment

Errors

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