README.md

CustomFields

(custom_fields)

Overview

Available Operations

• list - List Custom Fields
• create - Create Custom Field
• get - Get Custom Field
• update - Update Custom Field
• delete - Delete Custom Field

list

List custom fields.

Example Usage

from polar_sdk import Polar

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

    res = polar.custom_fields.list()

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
organization_id	OptionalNullable[models.CustomFieldsListQueryParamOrganizationIDFilter]	➖	Filter by organization ID.
query	OptionalNullable[str]	➖	Filter by custom field name or slug.
type_filter	OptionalNullable[models.CustomFieldTypeFilter]	➖	Filter by custom field type.
page	Optional[int]	➖	Page number, defaults to 1.
limit	Optional[int]	➖	Size of a page, defaults to 10. Maximum is 100.
sorting	List[models.CustomFieldSortProperty]	➖	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.CustomFieldsListResponse

Errors

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

create

Create a custom field.

Example Usage

from polar_sdk import Polar

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

    res = polar.custom_fields.create(request={
        "slug": "<value>",
        "name": "<value>",
        "properties": {},
        "type": "number",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	models.CustomFieldCreate	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.CustomField

Errors

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

get

Get a custom field by ID.

Example Usage

from polar_sdk import Polar

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

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

    # Handle response
    print(res)

Parameters

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

Response

models.CustomField

Errors

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

update

Update a custom field.

Example Usage

from polar_sdk import Polar

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

    res = polar.custom_fields.update(id="<value>", custom_field_update={
        "type": "text",
    })

    # Handle response
    print(res)

Parameters

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

Response

models.CustomField

Errors

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

delete

Delete a custom field.

Example Usage

from polar_sdk import Polar

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

    polar.custom_fields.delete(id="<value>")

    # Use the SDK ...

Parameters

Parameter	Type	Required	Description
id	str	✔️	The custom field ID.
retries	Optional[utils.RetryConfig]	➖	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	*/*