Skip to content

README.md

Latest commit

 

History

History
232 lines (150 loc) · 15 KB

README.md

File metadata and controls

232 lines (150 loc) · 15 KB

CheckoutLinks

(checkout_links)

Overview

Available Operations

  • list - List Checkout Links
  • create - Create Checkout Link
  • get - Get Checkout Link
  • update - Update Checkout Link
  • delete - Delete Checkout Link

list

List checkout links.

Scopes: checkout_links:read checkout_links:write

Example Usage

from polar_sdk import Polar


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

    res = polar.checkout_links.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.CheckoutLinksListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
product_id OptionalNullable[models.CheckoutLinksListQueryParamProductIDFilter] ➖ Filter by product 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.CheckoutLinkSortProperty] ➖ 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.CheckoutLinksListResponse

Errors

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

create

Create a checkout link.

Scopes: checkout_links:write

Example Usage

from polar_sdk import Polar


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

    res = polar.checkout_links.create(request={
        "payment_processor": "stripe",
        "allow_discount_codes": True,
        "require_billing_address": False,
        "product_price_id": "<value>",
    })

    # Handle response
    print(res)

Parameters

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

Response

models.CheckoutLink

Errors

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

get

Get a checkout link by ID.

Scopes: checkout_links:read checkout_links:write

Example Usage

from polar_sdk import Polar


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

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

    # Handle response
    print(res)

Parameters

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

Response

models.CheckoutLink

Errors

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

update

Update a checkout link.

Scopes: checkout_links:write

Example Usage

from polar_sdk import Polar


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

    res = polar.checkout_links.update(id="<value>", checkout_link_update={})

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The checkout link ID.
checkout_link_update models.CheckoutLinkUpdate ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CheckoutLink

Errors

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

delete

Delete a checkout link.

Scopes: checkout_links:write

Example Usage

from polar_sdk import Polar


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

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

    # Use the SDK ...

Parameters

Parameter Type Required Description
id str ✔️ The checkout link 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 */*