PolarOrders

May 19, 2026 · View on GitHub

(customer_portal.orders)

Overview

Available Operations

list - List Orders
get - Get Order
update - Update Order
generate_invoice - Generate Order Invoice
invoice - Get Order Invoice
receipt - Get Order Receipt
get_payment_status - Get Order Payment Status
confirm_retry_payment - Confirm Retry Payment

list

List orders of the authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.orders.list(security=polar_sdk.CustomerPortalOrdersListSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
`security`	models.CustomerPortalOrdersListSecurity	:heavy_check_mark:	N/A
`product_id`	OptionalNullable[models.CustomerPortalOrdersListQueryParamProductIDFilter]	:heavy_minus_sign:	Filter by product ID.
`product_billing_type`	OptionalNullable[models.CustomerPortalOrdersListQueryParamProductBillingTypeFilter]	:heavy_minus_sign:	Filter by product billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
`subscription_id`	OptionalNullable[models.CustomerPortalOrdersListQueryParamSubscriptionIDFilter]	:heavy_minus_sign:	Filter by subscription ID.
`query`	OptionalNullable[str]	:heavy_minus_sign:	Search by product or organization name.
`page`	Optional[int]	:heavy_minus_sign:	Page number, defaults to 1.
`limit`	Optional[int]	:heavy_minus_sign:	Size of a page, defaults to 10. Maximum is 100.
`sorting`	List[models.CustomerOrderSortProperty]	:heavy_minus_sign:	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]	:heavy_minus_sign:	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.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.orders.get(security=polar_sdk.CustomerPortalOrdersGetSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.CustomerPortalOrdersGetSecurity	:heavy_check_mark:	N/A
`id`	str	:heavy_check_mark:	The order ID.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	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	/

update

Update an order for the authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.orders.update(security=polar_sdk.CustomerPortalOrdersUpdateSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>", customer_order_update={
        "billing_address": {
            "country": polar_sdk.AddressInputCountryAlpha2Input.US,
        },
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.CustomerPortalOrdersUpdateSecurity	:heavy_check_mark:	N/A
`id`	str	:heavy_check_mark:	The order ID.
`customer_order_update`	models.CustomerOrderUpdate	:heavy_check_mark:	N/A
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	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	/

generate_invoice

Trigger generation of an order's invoice.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.orders.generate_invoice(security=polar_sdk.CustomerPortalOrdersGenerateInvoiceSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.CustomerPortalOrdersGenerateInvoiceSecurity	:heavy_check_mark:	N/A
`id`	str	:heavy_check_mark:	The order ID.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

Any

Errors

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

invoice

Get an order's invoice data.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.orders.invoice(security=polar_sdk.CustomerPortalOrdersInvoiceSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.CustomerPortalOrdersInvoiceSecurity	:heavy_check_mark:	N/A
`id`	str	:heavy_check_mark:	The order ID.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	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	/

receipt

Get a presigned URL to download an order's receipt PDF.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.orders.receipt(security=polar_sdk.CustomerPortalOrdersReceiptSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>")

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.CustomerPortalOrdersReceiptSecurity	:heavy_check_mark:	N/A
`id`	str	:heavy_check_mark:	The order ID.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.CustomerOrderReceipt

Errors

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

get_payment_status

Get the current payment status for an order.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.orders.get_payment_status(security=polar_sdk.CustomerPortalOrdersGetPaymentStatusSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.CustomerPortalOrdersGetPaymentStatusSecurity	:heavy_check_mark:	N/A
`id`	str	:heavy_check_mark:	The order ID.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.CustomerOrderPaymentStatus

Errors

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

confirm_retry_payment

Confirm a retry payment using a Stripe confirmation token.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.orders.confirm_retry_payment(security=polar_sdk.CustomerPortalOrdersConfirmRetryPaymentSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>", customer_order_confirm_payment={})

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.CustomerPortalOrdersConfirmRetryPaymentSecurity	:heavy_check_mark:	N/A
`id`	str	:heavy_check_mark:	The order ID.
`customer_order_confirm_payment`	models.CustomerOrderConfirmPayment	:heavy_check_mark:	N/A
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.CustomerOrderPaymentConfirmation

Errors

Error Type	Status Code	Content Type
models.ResourceNotFound	404	application/json
models.PaymentAlreadyInProgress	409	application/json
models.OrderNotEligibleForRetry	422	application/json
models.ManualRetryLimitExceeded	429	application/json
models.SDKError	4XX, 5XX	/