Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 9.5 KB

README.md

File metadata and controls

95 lines (65 loc) · 9.5 KB
Raw

Subscriptions

(subscriptions)

Overview

Available Operations

  • list - List Subscriptions
  • export - Export Subscriptions

list

List subscriptions.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.subscriptions.list()

    if res is not None:
        while True:
            # handle items

            res = res.next()
            if res is None:
                break

Parameters

Parameter Type Required Description
organization_id OptionalNullable[models.SubscriptionsListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
product_id OptionalNullable[models.SubscriptionsListQueryParamProductIDFilter] ➖ Filter by product ID.
discount_id OptionalNullable[models.DiscountIDFilter] ➖ Filter by discount ID.
active OptionalNullable[bool] ➖ Filter by active or inactive subscription.
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.SubscriptionSortProperty] ➖ 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.SubscriptionsListResponse

Errors

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

export

Export subscriptions as a CSV file.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.subscriptions.export()

    if res is not None:
        # handle response
        pass

Parameters

Parameter Type Required Description
organization_id OptionalNullable[models.OrganizationID] ➖ Filter by organization ID.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

Any

Errors

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