Skip to content

Latest commit

 

History

History
135 lines (89 loc) · 12.7 KB

README.md

File metadata and controls

135 lines (89 loc) · 12.7 KB
Raw

PolarOrders

(customer_portal.orders)

Overview

Available Operations

list

List orders of the authenticated customer or user.

Example Usage

from polar_sdk import Polar

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

    res = polar.customer_portal.orders.list()

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
organization_id OptionalNullable[models.CustomerPortalOrdersListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
product_id OptionalNullable[models.CustomerPortalOrdersListQueryParamProductIDFilter] ➖ Filter by product ID.
product_price_type OptionalNullable[models.CustomerPortalOrdersListQueryParamProductPriceTypeFilter] ➖ 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.
subscription_id OptionalNullable[models.QueryParamSubscriptionIDFilter] ➖ Filter by subscription ID.
query OptionalNullable[str] ➖ Search by product or organization name.
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.CustomerOrderSortProperty] ➖ 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.CustomerPortalOrdersListResponse

Errors

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

get

Get an order by ID for the authenticated customer or user.

Example Usage

from polar_sdk import Polar

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

    res = polar.customer_portal.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.CustomerOrder

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.

Example Usage

from polar_sdk import Polar

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

    res = polar.customer_portal.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.CustomerOrderInvoice

Errors

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