PolarCustomers

(customer_portal.customers)

Overview

Available Operations

• get - Get Customer
• update - Update Customer
• list_payment_methods - List Customer Payment Methods
• add_payment_method - Add Customer Payment Method
• confirm_payment_method - Confirm Customer Payment Method
• delete_payment_method - Delete Customer Payment Method
• request_email_update - Request Email Change
• check_email_update - Check Email Change Token
• verify_email_update - Verify Email Change

get

Get 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.customers.get(security=polar_sdk.CustomerPortalCustomersGetSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ))

    # Handle response
    print(res)

Parameters

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

Response

models.CustomerPortalCustomer

Errors

Error Type	Status Code	Content Type
models.SDKError	4XX, 5XX	*/*

update

Update authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.customers.update(security=polar_sdk.CustomerPortalCustomersUpdateSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), request={
        "billing_address": {
            "country": polar_sdk.AddressInputCountryAlpha2Input.US,
        },
    })

    # Handle response
    print(res)

Parameters

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

Response

models.CustomerPortalCustomer

Errors

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

list_payment_methods

Get saved payment methods of the authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.customers.list_payment_methods(security=polar_sdk.CustomerPortalCustomersListPaymentMethodsSecurity(
        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.CustomerPortalCustomersListPaymentMethodsSecurity	:heavy_check_mark:	N/A
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.
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.CustomerPortalCustomersListPaymentMethodsResponse

Errors

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

add_payment_method

Add a payment method to the authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.customers.add_payment_method(security=polar_sdk.CustomerPortalCustomersAddPaymentMethodSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), request={
        "confirmation_token_id": "<id>",
        "set_default": False,
        "return_url": "https://yearly-custom.net/",
    })

    # Handle response
    print(res)

Parameters

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

Response

models.CustomerPaymentMethodCreateResponse

Errors

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

confirm_payment_method

Confirm a payment method for the authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.customers.confirm_payment_method(security=polar_sdk.CustomerPortalCustomersConfirmPaymentMethodSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), request={
        "setup_intent_id": "<id>",
        "set_default": True,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.CustomerPaymentMethodCreateResponse

Errors

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

delete_payment_method

Delete a payment method from the authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    polar.customer_portal.customers.delete_payment_method(security=polar_sdk.CustomerPortalCustomersDeletePaymentMethodSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), id="<id>")

    # Use the SDK ...

Parameters

Parameter	Type	Required	Description
security	models.CustomerPortalCustomersDeletePaymentMethodSecurity	:heavy_check_mark:	N/A
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.PaymentMethodInUseByActiveSubscription	400	application/json
models.ResourceNotFound	404	application/json
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

request_email_update

Request an email change for the authenticated customer.

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.customers.request_email_update(security=polar_sdk.CustomerPortalCustomersRequestEmailUpdateSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), request={
        "email": "Tommie_Larkin78@gmail.com",
    })

    # Handle response
    print(res)

Parameters

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

Response

Any

Errors

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

check_email_update

Check if an email change verification token is still valid.

Example Usage

from polar_sdk import Polar


with Polar() as polar:

    polar.customer_portal.customers.check_email_update(token="<value>")

    # Use the SDK ...

Parameters

Parameter	Type	Required	Description
token	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.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

verify_email_update

Verify an email change using the token from the verification email.

Example Usage

from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.customers.verify_email_update(request={
        "token": "<value>",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	models.CustomerEmailUpdateVerifyRequest	: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.CustomerEmailUpdateVerifyResponse

Errors

Error Type	Status Code	Content Type
models.SDKError	4XX, 5XX	*/*