Skip to content

README.md

Latest commit

 

History

History
277 lines (184 loc) · 21 KB

README.md

File metadata and controls

277 lines (184 loc) · 21 KB

PolarCustomers

(customer_portal.customers)

Overview

Available Operations

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 ✔️ The security requirements to use for the request.
retries Optional[utils.RetryConfig] ➖ 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 ✔️ The request object to use for the request.
security models.CustomerPortalCustomersUpdateSecurity ✔️ The security requirements to use for the request.
retries Optional[utils.RetryConfig] ➖ 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 ✔️ N/A
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
retries Optional[utils.RetryConfig] ➖ 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 ✔️ The request object to use for the request.
security models.CustomerPortalCustomersAddPaymentMethodSecurity ✔️ The security requirements to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CustomerPaymentMethodCreateResponse

Errors

Error Type Status Code Content Type
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 ✔️ The request object to use for the request.
security models.CustomerPortalCustomersConfirmPaymentMethodSecurity ✔️ The security requirements to use for the request.
retries Optional[utils.RetryConfig] ➖ 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 ✔️ N/A
id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ 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 */*