Polar
API integration

create_a_polar_benefit

Create a new benefit in polar. Returns: id, type, description, organization_id, created_at, is_deletable, properties, metadata. Required: type, description.

delete_a_polar_benefit_by_id

Delete a polar benefit by id. All grants associated with the benefit will be revoked and users will lose access. Returns an empty 204 response on success. Required: id.

get_single_polar_benefit_by_id

Get a polar benefit by id. Returns: id, type, description, organization_id, created_at, is_deletable, properties, metadata. Required: id.

list_all_polar_benefits

List benefits in polar. Returns per item: id, type, description, organization_id, created_at, is_deletable, properties, metadata.

update_a_polar_benefit_by_id

Update an existing polar benefit by id. Accepts type-specific updates for custom, Discord, GitHub repository, downloadables, license key, meter credit, feature flag, and Slack shared channel benefits. Returns: id, type, description, organization_id, created_at, is_deletable, properties, metadata. Required: id.

list_all_polar_benefit_grants

List benefit grants in polar for a specific benefit. Returns: id, is_granted, customer_id, benefit_id, created_at, modified_at. Required: benefit_id. Optionally filter by organization_id, customer_id, external_customer_id, or is_granted status.

create_a_polar_checkout_link

Create a checkout link in polar. Returns: id, created_at, organization_id, product_id. Required: product_id.

delete_a_polar_checkout_link_by_id

Delete a polar checkout link by id. Returns an empty 204 response on success. Required: id.

get_single_polar_checkout_link_by_id

Get a polar checkout link by id. Returns: id, created_at, organization_id, product_id. Required: id.

list_all_polar_checkout_links

List checkout links in polar, with optional filtering by organization or product. Returns: id, created_at, organization_id, product_id per item.

update_a_polar_checkout_link_by_id

Update a polar checkout link by id. Returns: id, created_at, organization_id, product_id. Required: id.

update_a_polar_checkout_by_id

Update a polar checkout session by id. Returns the updated session including id, status, product_id, organization_id, customer_id, and created_at. Required: id.

create_a_polar_checkout

Create a new polar checkout session. Returns the created session including id, status, product_id, organization_id, customer_id, and created_at.

get_single_polar_checkout_by_id

Get a polar checkout session by id. Returns the full session including id, status, product_id, organization_id, customer_id, and created_at. Required: id.

list_all_polar_checkouts

List polar checkout sessions. Returns items where each includes id, status, product_id, organization_id, customer_id, and created_at. Optionally filter by organization_id, product_id, customer_id, external_customer_id, status, or query (customer email).

update_a_polar_checkout_session_by_id

Update a polar client checkout session by id. Returns the updated checkout session including its id. Required: id.

create_a_polar_custom_field

Create a custom field in polar. Returns: id, type, name, slug, organization_id, created_at, modified_at, metadata, properties. Required: type, name.

delete_a_polar_custom_field_by_id

Delete a polar custom field by id. Returns an empty 204 response on success. Required: id.

get_single_polar_custom_field_by_id

Get a polar custom field by id. Returns: id, type, name, slug, organization_id, created_at, modified_at, metadata, properties. Required: id.

list_all_polar_custom_fields

List custom fields in polar. Returns: id, type, name, slug, organization_id, created_at, modified_at. Optionally filter by organization_id, query (name or slug), or type.

update_a_polar_custom_field_by_id

Update a polar custom field by id. Returns: id, type, name, slug, organization_id, created_at, modified_at, metadata, properties. Required: id.

get_single_polar_customer_meter_by_id

Get a single polar customer meter by id. Returns the customer meter object including id, organization_id, customer_id, external_customer_id, meter_id, and modified_at. Required: id.

list_all_polar_customer_meters

List polar customer meters. Returns a paginated list of customer meter records including id, organization_id, customer_id, external_customer_id, meter_id, and modified_at. Optionally filter by organization_id, customer_id, external_customer_id, or meter_id.

get_single_polar_downloadable_by_id

Get a single polar customer portal downloadable by id. Returns: id. Required: id.

list_all_polar_downloadables

List polar customer portal downloadables accessible to the authenticated customer. Returns items containing id.

get_single_polar_customer_by_id

Get a polar customer by id. Returns the customer object including id, email, name, organization_id, external_id, metadata, billing_address, tax_id, and created_at. Required: id.

update_a_polar_customer_by_id

Update a polar customer by id. Returns the updated customer object including id, email, name, organization_id, external_id, metadata, billing_address, and created_at. Required: id.

create_a_polar_customer

Create a new polar customer. Returns the created customer object including id, email, name, organization_id, external_id, metadata, billing_address, and created_at. Required: email.

delete_a_polar_customer_by_id

Delete a polar customer by id, immediately cancelling their active subscriptions and revoking their benefits. Returns an empty 204 response on success. Required: id.

list_all_polar_customers

List polar customers with optional filtering by organization, email, name, or external ID. Returns items with id, email, name, organization_id, external_id, metadata, billing_address, tax_id, and created_at per customer.

get_single_polar_organization_by_id

Get a polar organization by id. Returns: id, name, slug, created_at. Required: id.

create_a_polar_organization

Create a new polar organization. Returns: id, name, slug, created_at. Required: name.

list_all_polar_organizations

List polar organizations, optionally filtered by slug. Returns one record per organization including id, name, slug, and created_at.

update_a_polar_organization_by_id

Update a polar organization by id. Returns the updated organization including id, name, slug, and created_at. Required: id.

create_a_polar_license_key

Activate a polar license key. Returns: id, organization_id, benefit_id, status.

delete_a_polar_license_key_by_id

Deactivate a polar license key activation. Returns an empty 204 response on success.

get_single_polar_license_key_by_id

Get a polar license key by id, including its full activations list. Returns: id, organization_id, benefit_id, status, activations. Required: id.

list_all_polar_license_keys

List polar license keys connected to the given organization, optionally filtered by benefit or status. Returns: id, organization_id, benefit_id, status per item.

update_a_polar_license_key_by_id

Update a polar license key by id. Returns: id, organization_id, benefit_id, status. Required: id.

get_single_polar_order_by_id

Get a polar order by id. Returns: id, status, amount, currency, customer_id, product_id, organization_id, created_at, invoice_number, subscription_id, checkout_id, discount_id, product_billing_type. Required: id.

list_all_polar_orders

List polar orders with optional filters by organization, product, billing type, customer, discount, checkout, or subscription. Returns: id, status, amount, currency, customer_id, product_id, organization_id, created_at, invoice_number, product_billing_type, subscription_id, checkout_id per item.

update_a_polar_order_by_id

Update a polar order by id. Returns: id, status, amount, currency, customer_id, product_id, organization_id, created_at, invoice_number, subscription_id, checkout_id, discount_id. Required: id.

create_a_polar_order

Generate an invoice for a polar order identified by order_id. Returns: id, status, invoice_number, amount, currency, customer_id, product_id, organization_id, created_at, product_billing_type. Required: order_id.

get_single_polar_order_invoice_by_id

Get the invoice for a polar order. Returns: id. Required: order_id.

delete_a_polar_payment_method_by_id

Delete a saved payment method from the polar customer portal by id. Returns an empty 204 response on success. Required: id.

list_all_polar_payment_methods

List saved payment methods for the current customer in the polar customer portal. Returns: id, type, created_at.

create_a_polar_seat

Create a seat in the polar customer portal. Returns: id.

list_all_polar_seats

List seats in the polar customer portal. Returns: id.

delete_a_polar_seat_by_id

Delete a seat from the polar customer portal by id. Returns an empty 204 response on success. Required: id.

list_all_polar_customer_portal_subscriptions

List subscriptions of the authenticated customer in polar. Returns: id, status, product_id, started_at, created_at, modified_at. Optionally filter by product_id, active/cancelled status, or search by product or organization name using query.

create_a_polar_customer_session

Create a customer session in polar, optionally triggering an automatic member session for the customer's owner member. Returns the created session including id, token, customer_id, and created_at. Required: either customer_id or customer_external_id (mutually exclusive).

delete_a_polar_subscription_by_id

Revoke a polar subscription immediately by id, canceling it at once rather than at period end. Returns the revoked subscription object including id, status, canceled_at, customer_id, product_id, and organization_id. Required: id.

get_single_polar_subscription_by_id

Get a polar subscription by id. Returns: id, status, cancel_at_period_end, started_at, canceled_at, customer_id, product_id, organization_id, discount_id, and metadata. Required: id.

list_all_polar_subscriptions

List polar subscriptions with optional filters by status, product, customer, organization, discount, and cancellation date range. Returns per item: id, status, cancel_at_period_end, customer_id, product_id, started_at, and organization_id.

update_a_polar_subscription_by_id

Update a polar subscription by id (e.g. schedule cancellation, change plan, or update metadata). Returns the updated subscription object including id, status, cancel_at_period_end, product_id, customer_id, and organization_id. Required: id.

create_a_polar_subscription

Create a polar subscription programmatically on a free product — no checkout flow, no initial order, and no confirmation email. Returns: id, status, customer_id, product_id, started_at, and organization_id. Required: product_id and either customer_id (existing polar customer) or customer_email (external customer).

create_a_polar_customer_seat

Assign a seat to a customer in polar for seat-based subscription or order pricing. Returns: id, customer_id, subscription_id, order_id, created_at.

get_single_polar_customer_seat_by_id

Get a polar customer seat by its claim id. Returns: id, customer_id, subscription_id, order_id, created_at. Required: id.

list_all_polar_customer_seats

List polar customer seats, optionally filtered by subscription or order. Returns: id, customer_id, subscription_id, order_id, created_at.

update_a_polar_customer_seat_by_id

Resend the seat assignment notification for a polar customer seat. Returns: id, customer_id, subscription_id, order_id, created_at. Required: seat_id.

delete_a_polar_customer_seat_by_id

Revoke a polar customer seat by id, removing the customer's seat-based access. Returns: id, customer_id, subscription_id, order_id, created_at. Required: id.

list_all_polar_customer_payment_methods

List payment methods associated with a specific Polar customer. Returns payment method records including id. Required: customer_id.

create_a_polar_discount

Create a new discount in polar. Returns: id, name, organization_id, created_at.

delete_a_polar_discount_by_id

Delete a polar discount by id. Returns an empty 204 response on success. Required: id.

get_single_polar_discount_by_id

Get a polar discount by id. Returns: id, name, organization_id, created_at. Required: id.

list_all_polar_discounts

List polar discounts. Returns: id, name, organization_id, created_at per item. Optionally filter by organization_id or discount name via query.

update_a_polar_discount_by_id

Update a polar discount by id. Returns: id, name, organization_id, created_at. Required: id.

get_single_polar_event_by_id

Get a single polar event by id. Returns: id, name, customer_id, external_customer_id, organization_id, source, timestamp, metadata, meter_id, parent_id. Required: id.

polar_events_bulk_create

Ingest multiple polar events at once via the /v1/events/ingest endpoint. Returns: id, name, customer_id, external_customer_id, organization_id, source, timestamp, metadata for each ingested event.

list_all_polar_events

List polar events with optional filtering by customer, organization, meter, name, source, timestamp range, or metadata key-value pairs. Returns: id, name, customer_id, external_customer_id, organization_id, source, timestamp, metadata, meter_id, parent_id. Depth filter supports up to 5 levels; defaults to all events when unset.

create_a_polar_event

Ingest a single polar event via the /v1/events/ingest endpoint. Returns: id, name, customer_id, external_customer_id, organization_id, source, timestamp, metadata, meter_id, parent_id.

update_a_polar_file_by_id

Update a polar file by id. Returns: id, organization_id, service. Required: id.

create_a_polar_file

Create a polar file. Returns: id, organization_id, service. Required: service.

delete_a_polar_file_by_id

Delete a polar file by id. Returns an empty 204 response on success. Required: id.

list_all_polar_files

List polar files. Returns: id, organization_id, service. Optionally filter by organization_id or ids.

get_single_polar_license_key_activation_by_id

Get a single polar license key activation by id. Returns the activation record including id, license_key_id, and created_at. Required: license_key_id, id.

create_a_polar_license_key_activation

Activate a polar license key. Returns the created activation record including id, license_key_id, and created_at. Required: license_key_id.

create_a_polar_member

Create a new polar member for a customer. Only B2B customers with the member management feature enabled can have members added. Returns: id, name, role, customer_id, created_at.

delete_a_polar_member_by_id

Delete a polar member by id. Returns an empty 204 response on success. Required: id.

get_single_polar_member_by_id

Get a polar member by id. Returns: id, name, role, customer_id, created_at. Required: id.

list_all_polar_members

List polar members with optional filtering by customer, external customer, or role. Returns: id, name, role, customer_id, created_at. Defaults to sorting by created_at descending.

update_a_polar_member_by_id

Update a polar member's name or role by id. Only name and role can be updated. Returns: id, name, role, customer_id, created_at. Required: id.

create_a_polar_meter

Create a meter in polar. Returns: id, name, organization_id, is_archived, created_at, modified_at. Required: name.

get_single_polar_meter_by_id

Get a single polar meter by id. Returns: id, name, organization_id, is_archived, created_at, modified_at. Required: id.

list_all_polar_meters

List meters in polar. Returns: id, name, organization_id, is_archived, created_at, modified_at. Optionally filter by organization_id, name query, is_archived status, sorting, or metadata key-value pairs.

update_a_polar_meter_by_id

Update a polar meter by id. Returns: id, name, organization_id, is_archived, created_at, modified_at. Required: id.

get_single_polar_meter_quantity_by_id

List quantity records for a specific polar meter. Returns: id, meter_id, quantity, created_at. Required: meter_id.

get_single_polar_metric_by_id

Get aggregated metrics from polar. No source documentation was discoverable for this endpoint; consult the polar API reference for the specific fields and query parameters supported.

create_a_polar_product

Create a new product in polar. Returns: id, name, organization_id, is_recurring, is_archived, created_at, visibility. Required: name.

get_single_polar_product_by_id

Get a polar product by id. Returns the product object including id, name, organization_id, is_recurring, is_archived, created_at, visibility, metadata, and benefits.

list_all_polar_products

List products in polar ordered by creation date. Returns per item: id, name, organization_id, is_recurring, is_archived, created_at, visibility. Supports filtering by id, organization_id, query (name), is_archived, is_recurring, benefit_id, and visibility.

update_a_polar_product_by_id

Update a polar product by id. Returns the updated product object including id, name, organization_id, is_recurring, is_archived, created_at, and visibility.

update_a_polar_product_benefit_by_id

Update the benefits associated with a product in polar. Returns an empty 204 response on success. Required: product_id.

create_a_polar_refund

Create a refund in polar for a specified order. Returns: id, order_id, customer_id, organization_id, subscription_id, external_customer_id, succeeded, created_at. Required: order_id.

list_all_polar_refunds

List polar refunds with optional filters by refund ID, order, subscription, customer, or succeeded status. Returns: id, order_id, customer_id, organization_id, subscription_id, external_customer_id, succeeded, created_at.

create_a_polar_webhook_endpoint

Create a new webhook endpoint in Polar. Returns: id, url, secret, events, created_at. Required: url.

delete_a_polar_webhook_endpoint_by_id

Delete a Polar webhook endpoint by id. Returns an empty 204 response on success.

get_single_polar_webhook_endpoint_by_id

Get a single Polar webhook endpoint by id. Returns: id, url, secret, events, created_at.

list_all_polar_webhook_endpoints

List all webhook endpoints configured in Polar. Returns one record per endpoint with: id, url, events, created_at.

update_a_polar_webhook_endpoint_by_id

Update an existing Polar webhook endpoint by id. Returns: id, url, secret, events, created_at. Required: id.

update_a_polar_webhooks_endpoint_by_id

Update a polar webhook endpoint by id. Returns the updated endpoint object including id, url, events, active, format, organization_id, created_at, and modified_at. Required: id.

get_single_polar_client_checkout_by_id

Get a polar client checkout session by id. Returns: id. Required: id.

create_a_polar_client_checkout_confirmation

Confirm a Polar client checkout session identified by its client secret. Returns an empty 204 response on success. Required: client_secret.

get_single_polar_customers_external_by_id

Get a polar customer by external id. Returns: id. Required: id.

update_a_polar_customers_external_by_id

Update a polar customer by external id. Returns: id. Required: id.

delete_a_polar_customers_external_by_id

Delete a polar customer by external id. Returns an empty 204 response on success. Required: id.

get_single_polar_customer_state_by_id

Get the current state of a polar customer by id. Returns the customer state object including id. Required: id.

get_single_polar_customer_external_state_by_id

Get the state of a polar external customer by their external id. Returns the customer state object, including id. Required: id.

get_single_polar_customer_portal_customer_by_id

Get the authenticated customer in polar's customer portal. Returns: id, email, email_verified, name, created_at, modified_at, metadata, external_id, billing_address, tax_id, organization_id.

update_a_polar_customer_portal_customer_by_id

Update the authenticated customer in polar's customer portal. Returns: id, email, email_verified, name, created_at, modified_at, metadata, external_id, billing_address, tax_id, organization_id.

list_all_polar_customer_external_payment_methods

List payment methods for a polar customer identified by their external ID. Returns: id, attributes. Required: external_id.

create_a_polar_file_upload

Mark a file upload as complete in polar. Confirms that the file referenced by file_id has been fully uploaded and is ready for use. Returns an empty 204 response on success. Required: file_id.

get_single_polar_customer_portal_organization_by_id

Get a customer portal organization by id in polar. Returns: id. Required: id.

create_a_polar_license_key_validation

Validate a polar license key against an organization. Returns: id, key, status, usage, validations, expires_at, and activation details. Required: key, organization_id.

list_all_polar_customer_license_keys

List license keys available in the polar customer portal. Returns: id, key, status.

get_single_polar_customer_license_key_by_id

Get a single polar customer portal license key by id. Returns: id, key, status. Required: id.

create_a_polar_customer_license_key_activation

Activate a polar license key through the customer portal. Returns: id, license_key_id, label, created_at. Required: key, label.

create_a_polar_customer_license_key_deactivation

Deactivate a license key activation in the polar customer portal. Submits the license key and activation ID to mark the activation as deactivated. Returns an empty 204 response on success. Required: key, activation_id.

create_a_polar_customer_license_key_validation

Validate a polar license key through the customer portal (no authentication required). Returns the license key's details including id, key, status, validations, last_validated_at, expires_at, and optional activation details. Required: key, organization_id.

get_single_polar_order_receipt_by_id

Get the receipt for a specific polar order. Returns the receipt object including its id. Required: order_id.

list_all_polar_customer_orders

List polar customer portal orders. Returns: id, created_at, modified_at, amount, tax_amount, currency, status, customer_id, product_id.

get_single_polar_customer_order_by_id

Get a single polar customer portal order by id. Returns: id, created_at, modified_at, amount, tax_amount, currency, status, customer_id, product_id.

update_a_polar_customer_order_by_id

Update a polar customer portal order by id. Returns: id, created_at, modified_at, amount, tax_amount, currency, status, customer_id, product_id.

create_a_polar_customer_order

Create an invoice for a polar customer portal order. Returns: url. Required: order_id.

get_single_polar_customer_order_invoice_by_id

Get the invoice for a specific order in the polar customer portal. Returns: url. Required: order_id.

get_single_polar_customer_order_receipt_by_id

Get the receipt for a specific polar customer portal order. Returns: id, created_at. Required: order_id.

create_a_polar_seat_resend

Resend a polar customer portal seat invitation or notification for a given seat. Required: seat_id. Returns an empty 204 response on success.

list_all_polar_customer_subscriptions

List all customer portal subscriptions in polar. Returns subscription items including id, status, amount, currency, recurring_interval, current_period_start, current_period_end, cancel_at_period_end, customer_id, product_id, and associated product and price objects.

get_single_polar_customer_subscription_by_id

Get a single customer portal subscription by id in polar. Returns: id, status, amount, currency, recurring_interval, current_period_start, current_period_end, cancel_at_period_end, customer_id, product_id, and associated product and price objects. Required: id.

update_a_polar_customer_subscription_by_id

Update a customer portal subscription by id in polar, for example to schedule cancellation at period end. Returns: id, status, cancel_at_period_end, current_period_end, customer_id, product_id, and the full updated subscription object. Required: id.

delete_a_polar_customer_subscription_by_id

Delete a customer portal subscription by id in polar. Returns an empty 204 response on success. Required: id.

create_a_polar_customer_seat_claim

Claim a customer seat in polar. Returns an empty 204 response on success.

get_single_polar_members_external_by_id

Get a single external member in polar by id. Returns: id.

update_a_polar_members_external_by_id

Update an external member in polar by id. Returns: id.

delete_a_polar_members_external_by_id

Delete an external member in polar by id. Returns an empty 204 response on success.

get_single_polar_metric_limit_by_id

Get metric limits from polar. Returns the metric limits configuration object for the metrics API; consult the upstream polar documentation for the full field-level breakdown of the returned limits data.