PolarSubscriptions

March 26, 2026 · View on GitHub

(customer_portal.subscriptions)

Overview

Available Operations

list - List Subscriptions
get - Get Subscription
update - Update Subscription
cancel - Cancel Subscription

list

List subscriptions of the authenticated customer.

Scopes: customer_portal:read customer_portal:write

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.subscriptions.list(security=polar_sdk.CustomerPortalSubscriptionsListSecurity(
        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.CustomerPortalSubscriptionsListSecurity	:heavy_check_mark:	N/A
`product_id`	OptionalNullable[models.CustomerPortalSubscriptionsListQueryParamProductIDFilter]	:heavy_minus_sign:	Filter by product ID.
`active`	OptionalNullable[bool]	:heavy_minus_sign:	Filter by active or cancelled subscription.
`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.CustomerSubscriptionSortProperty]	: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.CustomerPortalSubscriptionsListResponse

Errors

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

get

Get a subscription for the authenticated customer.

Scopes: customer_portal:read customer_portal:write

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

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

    # Handle response
    print(res)

Parameters

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

Response

models.CustomerSubscription

Errors

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

update

Update a subscription of the authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.subscriptions.update(security=polar_sdk.CustomerPortalSubscriptionsUpdateSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>", customer_subscription_update={})

    # Handle response
    print(res)

Parameters

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

Response

models.CustomerSubscription

Errors

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

cancel

Cancel a subscription of the authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.subscriptions.cancel(security=polar_sdk.CustomerPortalSubscriptionsCancelSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>")

    # Handle response
    print(res)

Parameters

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

Response

models.CustomerSubscription

Errors

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