Members

(members)

Overview

Available Operations

• list_members - List Members
• create_member - Create Member
• get_member - Get Member
• update_member - Update Member
• delete_member - Delete Member
• get_member_by_external_id - Get Member by External ID
• update_member_by_external_id - Update Member by External ID
• delete_member_by_external_id - Delete Member by External ID

list_members

List members with optional customer ID filter.

Scopes: members:read members:write

Example Usage

from polar_sdk import Polar


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

    res = polar.members.list_members(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
customer_id	OptionalNullable[str]	:heavy_minus_sign:	Filter by customer ID.
external_customer_id	OptionalNullable[str]	:heavy_minus_sign:	Filter by customer external ID.
role	OptionalNullable[models.MemberRole]	:heavy_minus_sign:	Filter by member role.
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.MemberSortProperty]	: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.MembersListMembersResponse

Errors

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

create_member

Create a new member for a customer.

Only B2B customers with the member management feature enabled can add members. The authenticated user or organization must have access to the customer's organization.

Scopes: members:write

Example Usage

from polar_sdk import Polar


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

    res = polar.members.create_member(request={
        "customer_id": "<value>",
        "email": "member@example.com",
        "name": "Jane Doe",
        "external_id": "usr_1337",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	models.MemberCreate	:heavy_check_mark:	The request object to use for the request.
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.Member

Errors

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

get_member

Get a member by ID.

The authenticated user or organization must have access to the member's organization.

Scopes: members:read members:write

Example Usage

from polar_sdk import Polar


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

    res = polar.members.get_member(id="572bebad-ee17-4d04-a50f-6596a7d92cf3")

    # Handle response
    print(res)

Parameters

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

Response

models.Member

Errors

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

update_member

Update a member.

Only name and role can be updated. The authenticated user or organization must have access to the member's organization.

Scopes: members:write

Example Usage

from polar_sdk import Polar


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

    res = polar.members.update_member(id="ab9b628a-6dbd-4f07-bcd6-163a8b5b7de4", member_update={
        "name": "Jane Doe",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
id	str	:heavy_check_mark:	N/A
member_update	models.MemberUpdate	:heavy_check_mark:	N/A
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.Member

Errors

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

delete_member

Delete a member.

The authenticated user or organization must have access to the member's organization.

Scopes: members:write

Example Usage

from polar_sdk import Polar


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

    polar.members.delete_member(id="913247e9-8f2b-4bd1-a47e-9842d173a7cb")

    # Use the SDK ...

Parameters

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

Errors

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

get_member_by_external_id

Get a member by external ID. One of customer_id or external_customer_id must be specified.

Scopes: members:read members:write

Example Usage

from polar_sdk import Polar


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

    res = polar.members.get_member_by_external_id(external_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
external_id	str	:heavy_check_mark:	The member external ID.
customer_id	OptionalNullable[str]	:heavy_minus_sign:	The customer ID.
external_customer_id	OptionalNullable[str]	:heavy_minus_sign:	The customer external ID.
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.Member

Errors

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

update_member_by_external_id

Update a member by external ID. One of customer_id or external_customer_id must be specified.

Scopes: members:write

Example Usage

from polar_sdk import Polar


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

    res = polar.members.update_member_by_external_id(external_id="<id>", member_update={
        "name": "Jane Doe",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
external_id	str	:heavy_check_mark:	The member external ID.
member_update	models.MemberUpdate	:heavy_check_mark:	N/A
customer_id	OptionalNullable[str]	:heavy_minus_sign:	The customer ID.
external_customer_id	OptionalNullable[str]	:heavy_minus_sign:	The customer external ID.
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.Member

Errors

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

delete_member_by_external_id

Delete a member by external ID. One of customer_id or external_customer_id must be specified.

Scopes: members:write

Example Usage

from polar_sdk import Polar


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

    polar.members.delete_member_by_external_id(external_id="<id>")

    # Use the SDK ...

Parameters

Parameter	Type	Required	Description
external_id	str	:heavy_check_mark:	The member external ID.
customer_id	OptionalNullable[str]	:heavy_minus_sign:	The customer ID.
external_customer_id	OptionalNullable[str]	:heavy_minus_sign:	The customer external ID.
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Errors

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