Skip to content

Latest commit

 

History

History
145 lines (93 loc) · 13.3 KB

README.md

File metadata and controls

145 lines (93 loc) · 13.3 KB

Orders

(orders)

Overview

Available Operations

list

List orders.

Scopes: orders:read

Example Usage

from polar_sdk import Polar


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

    res = polar.orders.list()

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
organization_id OptionalNullable[models.OrdersListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
product_id OptionalNullable[models.OrdersListQueryParamProductIDFilter] ➖ Filter by product ID.
product_price_type OptionalNullable[models.ProductPriceTypeFilter] ➖ Filter by product price type. recurring will return orders corresponding to subscriptions creations or renewals. one_time will return orders corresponding to one-time purchases.
discount_id OptionalNullable[models.QueryParamDiscountIDFilter] ➖ Filter by discount ID.
customer_id OptionalNullable[models.OrdersListQueryParamCustomerIDFilter] ➖ Filter by customer ID.
checkout_id OptionalNullable[models.CheckoutIDFilter] ➖ Filter by checkout ID.
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.OrderSortProperty] ➖ 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.OrdersListResponse

Errors

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

get

Get an order by ID.

Scopes: orders:read

Example Usage

from polar_sdk import Polar


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

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

    # Handle response
    print(res)

Parameters

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

Response

models.Order

Errors

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

invoice

Get an order's invoice data.

Scopes: orders:read

Example Usage

from polar_sdk import Polar


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

    res = polar.orders.invoice(id="<value>")

    # Handle response
    print(res)

Parameters

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

Response

models.OrderInvoice

Errors

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