Skip to content

Latest commit

 

History

History
238 lines (154 loc) · 17 KB

README.md

File metadata and controls

238 lines (154 loc) · 17 KB

Subscriptions

(subscriptions)

Overview

Available Operations

  • list - List Subscriptions
  • export - Export Subscriptions
  • get - Get Subscription
  • update - Update Subscription
  • revoke - Revoke Subscription

list

List subscriptions.

Scopes: subscriptions:read subscriptions:write

Example Usage

from polar_sdk import Polar


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

    res = polar.subscriptions.list(organization_id=[
        "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    ])

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
organization_id OptionalNullable[models.OrganizationIDFilter] ➖ Filter by organization ID.
product_id OptionalNullable[models.ProductIDFilter] ➖ Filter by product ID.
customer_id OptionalNullable[models.CustomerIDFilter] ➖ Filter by customer 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.

Scopes: subscriptions:read subscriptions:write

Example Usage

from polar_sdk import Polar


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

    res = polar.subscriptions.export(organization_id=[
        "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    ])

    # Handle response
    print(res)

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 */*

get

Get a subscription by ID.

Scopes: subscriptions:write

Example Usage

from polar_sdk import Polar


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

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

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The subscription ID.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.Subscription

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.

Scopes: subscriptions:write

Example Usage

from polar_sdk import Polar


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

    res = polar.subscriptions.update(id="<value>", subscription_update={
        "revoke": True,
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The subscription ID.
subscription_update models.SubscriptionUpdate ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.Subscription

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 */*

revoke

Revoke a subscription, i.e cancel immediately.

Scopes: subscriptions:write

Example Usage

from polar_sdk import Polar


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

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

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The subscription ID.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.Subscription

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 */*