Skip to content

Latest commit

 

History

History
179 lines (119 loc) · 14.6 KB

README.md

File metadata and controls

179 lines (119 loc) · 14.6 KB
Raw

PolarSubscriptions

(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 or user.

Example Usage

from polar_sdk import Polar

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

    res = polar.customer_portal.subscriptions.list()

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
organization_id OptionalNullable[models.CustomerPortalSubscriptionsListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
product_id OptionalNullable[models.CustomerPortalSubscriptionsListQueryParamProductIDFilter] ➖ Filter by product ID.
active OptionalNullable[bool] ➖ Filter by active or cancelled subscription.
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.CustomerSubscriptionSortProperty] ➖ 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.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 or user.

Example Usage

from polar_sdk import Polar

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

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

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ Customer subscription ID.
retries Optional[utils.RetryConfig] ➖ 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 or user.

Example Usage

from polar_sdk import Polar

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

    res = polar.customer_portal.subscriptions.update(id="<value>", customer_subscription_update={
        "product_price_id": "<value>",
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ Customer subscription ID.
customer_subscription_update models.CustomerSubscriptionUpdate ✔️ N/A
retries Optional[utils.RetryConfig] ➖ 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 */*

cancel

Cancel a subscription 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.subscriptions.cancel(id="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ Customer subscription ID.
retries Optional[utils.RetryConfig] ➖ 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 */*