Skip to content

README.md

Latest commit

 

History

History
104 lines (68 loc) · 10.5 KB

README.md

File metadata and controls

104 lines (68 loc) · 10.5 KB

PolarCustomerMeters

(customer_portal.customer_meters)

Overview

Available Operations

  • list - List Meters
  • get - Get Customer Meter

list

List meters of the authenticated customer.

Scopes: customer_portal:read customer_portal:write

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.customer_meters.list(security=polar_sdk.CustomerPortalCustomerMetersListSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
security models.CustomerPortalCustomerMetersListSecurity ✔️ N/A
meter_id OptionalNullable[models.MeterIDFilter] ➖ Filter by meter ID.
query OptionalNullable[str] ➖ Filter by meter name.
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.CustomerCustomerMeterSortProperty] ➖ 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.CustomerPortalCustomerMetersListResponse

Errors

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

get

Get a meter by ID for the authenticated customer.

Scopes: customer_portal:read customer_portal:write

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.customer_meters.get(security=polar_sdk.CustomerPortalCustomerMetersGetSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<value>")

    # Handle response
    print(res)

Parameters

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

Response

models.CustomerCustomerMeter

Errors

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