Skip to content

README.md

Latest commit

 

History

History
102 lines (66 loc) · 9.82 KB

README.md

File metadata and controls

102 lines (66 loc) · 9.82 KB

CustomerMeters

(customer_meters)

Overview

Available Operations

  • list - List Customer Meters
  • get - Get Customer Meter

list

List customer meters.

Scopes: customer_meters:read

Example Usage

from polar_sdk import Polar


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

    res = polar.customer_meters.list(organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737", page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
organization_id OptionalNullable[models.CustomerMetersListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
customer_id OptionalNullable[models.CustomerMetersListQueryParamCustomerIDFilter] ➖ Filter by customer ID.
external_customer_id OptionalNullable[models.CustomerMetersListQueryParamExternalCustomerIDFilter] ➖ Filter by external customer ID.
meter_id OptionalNullable[models.QueryParamMeterIDFilter] ➖ Filter by meter 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.CustomerMeterSortProperty] ➖ 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.CustomerMetersListResponse

Errors

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

get

Get a customer meter by ID.

Scopes: customer_meters:read

Example Usage

from polar_sdk import Polar


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

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

    # Handle response
    print(res)

Parameters

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

Response

models.CustomerMeter

Errors

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