(customers.members)
- create - Create Member
- create_external - Create Member by Customer External ID
- get - Get Member
- update - Update Member
- delete - Delete Member
- get_external - Get Member by External ID
- update_external - Update Member by External ID
- delete_external - Delete Member by External ID
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
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.customers.members.create(id="<value>", member_create_from_customer={
"email": "member@example.com",
"name": "Jane Doe",
"external_id": "usr_1337",
})
# Handle response
print(res)| Parameter | Type | Required | Description |
|---|---|---|---|
id |
str | ✔️ | The customer ID. |
member_create_from_customer |
models.MemberCreateFromCustomer | ✔️ | N/A |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models.NotPermitted | 403 | application/json |
| models.ResourceNotFound | 404 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |
Create a new member for a customer identified by its external ID.
Scopes: members:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.customers.members.create_external(external_id="<id>", member_create_from_customer={
"email": "member@example.com",
"name": "Jane Doe",
"external_id": "usr_1337",
})
# Handle response
print(res)| Parameter | Type | Required | Description |
|---|---|---|---|
external_id |
str | ✔️ | The customer external ID. |
member_create_from_customer |
models.MemberCreateFromCustomer | ✔️ | N/A |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models.NotPermitted | 403 | application/json |
| models.ResourceNotFound | 404 | application/json |
| models.AmbiguousExternalCustomerID | 409 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |
Get a member of a customer by its ID.
Scopes: members:read members:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.customers.members.get(id="<value>", member_id="a794a9c8-dc43-40b4-b2f5-ed16145e28ac")
# Handle response
print(res)| Parameter | Type | Required | Description |
|---|---|---|---|
id |
str | ✔️ | The customer ID. |
member_id |
str | ✔️ | N/A |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models.ResourceNotFound | 404 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |
Update a member of a customer.
Only name, email and role can be updated.
Scopes: members:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.customers.members.update(id="<value>", member_id="f48ea05d-6a60-4bb1-b3d9-4b3cd7194f3a", member_update={
"name": "Jane Doe",
})
# Handle response
print(res)| Parameter | Type | Required | Description |
|---|---|---|---|
id |
str | ✔️ | The customer ID. |
member_id |
str | ✔️ | N/A |
member_update |
models.MemberUpdate | ✔️ | N/A |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models.ResourceNotFound | 404 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |
Delete a member of a customer.
Scopes: members:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
polar.customers.members.delete(id="<value>", member_id="a6d6f519-f76e-49a0-9868-b346c98100a6")
# Use the SDK ...| Parameter | Type | Required | Description |
|---|---|---|---|
id |
str | ✔️ | The customer ID. |
member_id |
str | ✔️ | N/A |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models.ResourceNotFound | 404 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |
Get a member by external ID for a customer identified by its external ID.
Scopes: members:read members:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.customers.members.get_external(external_id="<id>", member_external_id="<id>")
# Handle response
print(res)| Parameter | Type | Required | Description |
|---|---|---|---|
external_id |
str | ✔️ | The customer external ID. |
member_external_id |
str | ✔️ | The member external ID. |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models.ResourceNotFound | 404 | application/json |
| models.AmbiguousExternalCustomerID | 409 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |
Update a member by external ID for a customer identified by its external ID.
Scopes: members:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.customers.members.update_external(external_id="<id>", member_external_id="<id>", member_update={
"name": "Jane Doe",
})
# Handle response
print(res)| Parameter | Type | Required | Description |
|---|---|---|---|
external_id |
str | ✔️ | The customer external ID. |
member_external_id |
str | ✔️ | The member external ID. |
member_update |
models.MemberUpdate | ✔️ | N/A |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models.ResourceNotFound | 404 | application/json |
| models.AmbiguousExternalCustomerID | 409 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |
Delete a member by external ID for a customer identified by its external ID.
Scopes: members:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
polar.customers.members.delete_external(external_id="<id>", member_external_id="<id>")
# Use the SDK ...| Parameter | Type | Required | Description |
|---|---|---|---|
external_id |
str | ✔️ | The customer external ID. |
member_external_id |
str | ✔️ | The member external ID. |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models.ResourceNotFound | 404 | application/json |
| models.AmbiguousExternalCustomerID | 409 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |