(users.benefits)
List my granted benefits.
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.users.benefits.list()
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
break| Parameter | Type | Required | Description |
|---|---|---|---|
type_filter |
OptionalNullable[models.BenefitTypeFilter] | ➖ | Filter by benefit type. |
organization_id |
OptionalNullable[models.OrganizationIDFilter] | ➖ | Filter by organization ID. |
order_id |
OptionalNullable[models.OrderIDFilter] | ➖ | Filter by order ID. |
subscription_id |
OptionalNullable[models.SubscriptionIDFilter] | ➖ | Filter by subscription ID. |
page |
Optional[int] | ➖ | Page number, defaults to 1. |
limit |
Optional[int] | ➖ | Size of a page, defaults to 10. Maximum is 100. |
sorting |
List[models.UserBenefitSortProperty] | ➖ | 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. |
models.UsersBenefitsListResponse
| Error Type | Status Code | Content Type |
|---|---|---|
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |
Get a granted benefit by ID.
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.users.benefits.get(id="<value>")
if res is not None:
# handle response
pass| Parameter | Type | Required | Description |
|---|---|---|---|
id |
str | ✔️ | The benefit ID. |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
models.UsersBenefitsGetResponseUsersBenefitsGet
| Error Type | Status Code | Content Type |
|---|---|---|
| models.ResourceNotFound | 404 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |