Reference

checkout.created

Fires when a new checkout session is created. This marks the beginning of a customer's purchase journey.

customer_seat.claimed

Fires when a customer claims an available seat for a licensed product. This happens when a user activates their license for the first time.

customer.created

Fires when a new customer is created after checkout or via API

order.paid

Fires when an order is fully paid and payment is received

order.refunded

Fires when an order is fully or partially refunded

subscription.active

Fires when a subscription becomes active or payment is recovered

subscription.canceled

Fires when a subscription is canceled by the customer or system

subscription.created

Fires when a new subscription is created

subscription.past_due

Fires when a subscription payment fails and enters past-due status

benefit_grant.created

Fires when a benefit is granted to a customer. The customer can now use this benefit immediately.

benefit_grant.cycled

Fires when a benefit grant completes its billing cycle. This typically resets usage limits or counters for the next period.

benefit_grant.revoked

Fires when a granted benefit is taken away from a customer. The customer can no longer use this benefit.

benefit_grant.updated

Fires when a granted benefit's details are modified. This includes status changes or property updates.

benefit.created

Fires when a new benefit is created and added to a product. This new perk is now available to customers.

benefit.updated

Fires when benefit details or configuration are changed. This includes updating eligibility rules or descriptions.

checkout.expired

Fires when a checkout session expires without being completed. This happens after the checkout link becomes invalid.

checkout.updated

Fires when checkout details are modified before completion. This includes changes to items, pricing, or customer information.

customer_seat.assigned

Fires when a seat is assigned to a customer for a licensed product. This grants them access to use the product.

customer_seat.revoked

Fires when a customer loses their seat assignment for a licensed product. This removes their access to the product.

customer.deleted

Fires when a customer account is permanently removed from the system. This typically happens when a customer requests account deletion.

customer.state_changed

Fires when a customer's status changes within the system. Examples include transitioning from trial to active or becoming inactive.

customer.updated

Fires when an existing customer's information is modified. This includes profile updates, contact details, or preferences.

member.created

Fires when a new team or organization member is added. This happens when someone joins your account or workspace.

member.deleted

Fires when a team or organization member is removed. This happens when someone leaves or is removed from the account.

member.updated

Fires when a member's details or permissions are modified. This includes role changes or profile updates.

order.created

Fires when a new order is created. This marks a customer's purchase request in the system.

order.updated

Fires when order details are modified after creation. This includes status updates or adjustments to items or pricing.

organization.updated

Fires when organization or account settings are updated. This includes name, billing address, or preferences.

product.created

Fires when a new product is added to your catalog. This makes it available for customers to purchase.

product.updated

Fires when product information is modified. This includes pricing, description, or availability changes.

refund.created

Fires when a refund is initiated for a customer. This marks the beginning of the refund process.

refund.updated

Fires when refund details or status are updated. This includes processing status changes or amount adjustments.

subscription.revoked

Fires when a subscription is revoked and access is lost immediately

subscription.uncanceled

Fires when a canceled subscription is reactivated before its end date. The customer resumes their service.

subscription.updated

Fires when subscription details are changed. This includes plan upgrades, downgrades, or schedule modifications.

List all benefit grants

Retrieve a complete list of all benefit grants to see which customers have access to which benefits across your organization. Use this to audit entitlements, manage customer access, and build dashboards showing benefit distribution.

Create a new benefit

Create a new benefit to offer customers after they make a purchase, such as license keys, downloadable files, repository access, or Discord roles.

Delete a benefit

Permanently remove a benefit from your product offering, immediately revoking access for all customers who currently have it. Use this when you're completely discontinuing a benefit rather than temporarily pausing it.

Get a benefit by ID

Retrieve detailed information about a specific benefit, including its type, configuration, and which products it's attached to. Use this to verify benefit settings, display them to customers, or check product eligibility.

List all benefits

Retrieve all benefits you've set up for your products, such as license keys, downloads, or access perks that customers receive when they purchase. Use this to review your complete benefit catalog and understand what you're currently offering.

List grants for a specific benefit

View all customers who have been granted access to a specific benefit, helping you track benefit distribution and verify customer access levels.

Update a benefit

Modify an existing benefit's settings, such as license keys, download URLs, Discord role assignments, or other type-specific configurations to keep your customer rewards current and relevant.

Create a reusable checkout link

Create a reusable checkout link for your products that generates a new transaction session each time someone visits it. Use this to build persistent buy buttons and shareable purchase links that work across your marketing channels.

Delete a checkout link

Permanently removes a checkout link so its URL becomes inactive and no longer processes transactions. This helps you manage your sales funnel by retiring outdated or compromised links.

Get a checkout link by ID

Retrieves the details of a specific checkout link, including its URL, associated product, discounts, and performance metrics. Use this to verify your checkout configuration or display link information in your admin interface.

List all checkout links

Retrieve all your reusable checkout links so you can view, organize, and manage the payment pages you've created for your products and services.

Update a checkout link

Modify an existing checkout link's settings including its label, applied discounts, and post-purchase redirect URL without needing to create a new link.

Confirm and finalize a checkout session

Complete a customer's purchase by confirming their checkout session, which processes payment and delivers their products or subscription access immediately.

Create a new checkout session

Initiates a payment session that generates a checkout URL for customers to complete purchases, allowing you to embed payment collection directly into your application or send payment links to customers.

Get a checkout session by client secret

Retrieve checkout session details using a client-safe identifier to display payment information and order summaries in your frontend application without exposing sensitive server data.

Get a checkout session by ID

Retrieve detailed information about a specific checkout session including its status, products, and customer details to verify payment completion or display order confirmations.

List all checkout sessions

Retrieve all checkout sessions created by your organization to monitor sales funnels and understand customer purchasing behavior. Use this data to identify abandoned carts, track conversion rates, and optimize your checkout process.

Update a checkout session

Modify checkout session details like customer email, discount codes, and custom fields before the purchase is completed. This lets you personalize the checkout experience or apply promotions in real-time based on customer actions.

Update a checkout session from the client

Captures customer information like email, billing address, and tax details during checkout using client-side updates. Use this to collect required customer data and custom form responses directly from your checkout page.

Create a new custom field

Add a new custom field to collect specific information from customers during checkout, such as company details or tax IDs, helping you gather structured data tailored to your business needs.

Delete a custom field

Remove a custom field from your checkout flow while preserving all historical data collected through that field on past orders.

Get a custom field by ID

Retrieves the complete configuration details of a specific custom field, including its type, label, and properties. Use this to display field information in your admin interface or dynamically build forms based on stored field definitions.

List all custom fields

Retrieve all custom fields you've created to extend order and checkout data in your Polar workspace. Use this to see your entire custom field schema and manage what additional information you're collecting.

Update a custom field

Modify a custom field's label, validation rules, or display settings to keep your data structure aligned with your business needs. This allows you to rename fields or adjust their properties without disrupting existing data.

Assign a seat to a user

Provision a subscription seat for a team member by assigning it to their email address, triggering an invitation for them to activate their access.

Claim an assigned seat

Allows a user to accept a seat invitation and gain access to subscription benefits by using their unique invitation token.

Get seat claim information

Retrieves details about a seat invitation so you can show users what subscription and benefits they'll receive before claiming their seat.

List all assigned seats

View all currently assigned seats across your customer subscriptions to understand who has access and which seats are in use.

Resend a seat invitation

Sends a fresh invitation email to claim a seat assignment when the original invitation was missed, expired, or went to spam. Use this to ensure team members can access their assigned seats without creating duplicate assignments.

Revoke a seat assignment

Remove a user's access to a subscription by revoking their assigned seat, allowing you to free up that license for another team member.

Create a customer portal session

Creates an authenticated session that allows customers to securely access and manage their subscriptions, billing information, and account benefits directly from your application.

Get a customer meter reading

Retrieve a specific customer's current usage data and billing period information to monitor their consumption levels. Use this to track how much of their plan they've used and identify when they're approaching their limits.

List customer meter readings

Retrieve meter readings for your customers to track their usage and monitor billing metrics. This helps you understand consumption patterns and ensure accurate usage-based billing.

Activate a license key from client

Enables customers to activate license keys on their devices or installations directly from your customer portal without requiring authentication. Returns an activation ID that can be used for future deactivation or license management.

Add a member to your team

Invite a new team member to your organization by email, allowing them to access shared resources and collaborate on projects. If the email is already associated with your team, the existing member record is returned.

Add a new payment method

Enables customers to securely add and store a new payment method to their account, such as a credit card or alternative payment option. This helps reduce transaction failures and improves customer checkout flexibility.

Assign a seat to a team member

Invite a team member to join your subscription by assigning them an available seat and sending them a claim invitation via email.

Cancel your subscription

Allows customers to cancel their active subscriptions through a self-service portal, with access typically continuing until the end of the current billing period. This enables solopreneurs to offer a frictionless cancellation experience without manual intervention.

Check payment status for an order

Retrieve the current payment status for a specific order to understand whether payment is pending, completed, or needs customer action. Use this to provide customers with real-time payment progress updates and determine if follow-up actions are required.

Confirm a pending payment method

Completes the setup of a new payment method after the customer has finished any required authentication steps, such as 3D Secure verification. This ensures the payment method is fully activated and ready for transactions.

Confirm a retry payment

Processes a retry payment for an order that previously failed, allowing customers to complete their purchase with an updated payment method. This helps recover lost sales when initial payment attempts don't go through.

Deactivate a license key from client

Allows customers to deactivate their license keys from a specific device or installation, immediately freeing up the activation slot for use elsewhere. This is typically called from customer-facing applications when users switch devices or no longer need access on a particular machine.

Generate an invoice for your order

Generates a PDF invoice for a specific order that customers can download directly from your portal, making it easy for them to access invoices for their accounting needs whenever they need them.

Get a benefit grant by ID

Retrieve detailed information about a specific benefit grant that a customer has received, including what benefit was granted and which subscription it's linked to.

Get a license key by ID

Retrieve detailed information about a specific license key, including its activation status, usage limits, and expiration date. Use this to verify license validity, check how many devices are still available for activation, or display license details to your customers.

Get a specific usage meter

Retrieve detailed usage data for a specific metered resource, including current consumption and billing period information. This helps you display usage breakdowns and progress indicators to your customers.

Get a subscription by ID

Retrieve the complete details of a specific subscription, including the current plan, billing period, and product information, so you can display accurate subscription status and management options to your customers.

Get a wallet by ID

View a customer's wallet details including their current balance, currency, and recent transactions to understand their account status and spending activity.

Get an order by ID

Fetch detailed information about a specific customer order, including items, pricing, and payment status. This enables you to display order confirmations and billing details to your customers.

Get invoice data for your order

Retrieve detailed invoice information for a specific order, including line items, taxes, and seller details to display or generate custom invoices for your customers.

Get the authenticated portal user

Fetch the details of the currently logged-in customer in your portal to personalize their experience and display their account information.

Get the portal organization

Retrieve your organization's details and branding information for your customer portal by providing its unique identifier, allowing you to display consistent branding across customer-facing pages.

Get your customer profile

Retrieve the authenticated customer's profile information including name, email, billing address, and any custom data stored in their account. Use this to display account settings and pre-fill forms in your customer portal.

Inspect current portal session

Verify the validity and details of a customer's current portal session, including their identity and permissions. Use this to confirm a customer is logged in and has access to specific features before allowing them to perform actions.

List subscriptions where you have a seat

Retrieve all subscriptions where the authenticated customer has an active seat, allowing you to display their current team memberships and access to shared subscriptions.

List your benefit grants

Retrieve the list of benefits a customer has earned through their purchases, showing their current entitlements and access rights. Use this to display what the customer has unlocked in your customer portal.

List your downloadable files

Retrieve a customer's available downloadable files from their purchases so you can display them in a customer portal or dashboard. This lets your customers easily access digital products, software, or media they've bought from you.

List your license keys

Retrieve all license keys granted to the authenticated customer, enabling them to view and manage their software licenses in one place.

List your order history

Retrieve a customer's complete order history including one-time purchases and subscription renewals to display billing records and transaction details in your customer portal.

List your saved payment methods

Retrieve all payment methods saved to your customer account, including credit cards and other payment instruments. Use this to display a payment method management interface where your customers can view and manage their stored payment options.

List your subscriptions

Retrieves all active and past subscriptions for the authenticated customer, allowing you to display their subscription history and current plans in your customer portal. Use this to help customers manage their accounts and understand their billing status.

List your team members

Retrieve all members of your team to view and manage who has access to your account. This helps you keep track of your team roster and coordinate permissions across your organization.

List your team seats

Retrieve all seat assignments for your team members on per-seat subscription plans, including pending invitations and available capacity. This helps you manage who has access to your subscription and track your team's resource usage.

List your usage meters

Retrieve your customer's current usage data across metered billing dimensions to display consumption tracking and plan limits in your customer portal.

List your wallets

Retrieve all wallet accounts associated with your customer profile, including their current prepaid credit balances that can be used for purchases or subscriptions.

Remove a member from your team

Revoke a team member's access to your Polar account by removing them from your team. Use this when team members leave or no longer need platform access.

Remove a saved payment method

Allows customers to remove a saved payment method from their account, such as expired or unwanted credit cards. This helps customers manage their payment information and keep their account clean.

Resend a seat invitation email

Resend an invitation email to a team member for an unclaimed seat when the original message wasn't received or has been lost. This helps you quickly get team members onboarded without creating duplicate invitations.

Revoke a team seat

Remove a team member's access to subscription benefits by revoking their assigned seat. This frees up the seat so you can reassign it to another team member when needed.

Update a benefit grant

Allows customers to modify settings for their benefit grants, such as changing which GitHub repository is connected or updating custom integration configurations.

Update a team member's role

Change a team member's role and permissions within your organization, allowing you to grant or revoke access levels as your team grows or responsibilities shift.

Update order details

Allow customers to update their billing information directly, such as correcting their address or custom details for accurate invoicing without requiring manual intervention.

Update your customer profile

Allow customers to update their own profile information like name, email, and billing address through your customer portal, reducing the need for manual account management.

Update your subscription

Allows customers to modify their subscription details directly, such as upgrading to a higher tier, downgrading their plan, or switching products without needing your intervention.

Validate a license key from client

Verify that a customer's license key is valid and has available activations remaining, enabling you to grant access to your product from client-side applications without exposing sensitive credentials.

List all customers

Retrieve a paginated list of all customers in your organization with support for filtering by email, organization, and metadata to help you search, manage, and organize customer information.

Create a new customer

Create a customer record in Polar to register new buyers before purchase or sync existing customers from your application. This enables you to maintain a unified customer database and track customer relationships across your sales channels.

Delete a customer by external ID

Remove a customer from your billing system and immediately cancel all their active subscriptions and benefits. Use this when you need to delete a user account from your application while ensuring their Polar billing data is also cleaned up.

Delete a customer permanently

Permanently remove a customer record from your business and automatically cancel their active subscriptions and benefits, with an option to anonymize their personal data for privacy compliance.

Export customers as CSV

Download your complete customer list as a CSV file containing contact details and metadata for external use or analysis.

Get a customer by ID

Retrieve detailed information about a specific customer by their ID, including their email, name, and any associated metadata. Use this to display customer profiles, verify customer identity, or load customer context before performing account operations.

Get a customer's full state

Retrieve a complete snapshot of a customer's current subscriptions, benefits, and entitlements to understand exactly what they have access to. Use this to check customer status, control feature access, and keep your customer dashboards up-to-date.

Get customer state by external ID

Retrieve a customer's subscription status, benefits, and entitlements using your own user ID system, enabling you to check what features they have access to without maintaining separate ID mappings.

Look up a customer by your external ID

Retrieve a customer's account details and subscription information using your own user ID instead of Polar's internal identifier, letting you seamlessly connect your app's user database with their subscription data.

Update a customer

Modify a customer's profile information including name, email, and billing details to keep your records synchronized with current customer data.

Update a customer by external ID

Update customer information in Polar using your own user ID system, keeping customer profiles synchronized between your application and Polar without managing separate ID mappings.

Create a new discount

Create promotional discounts that customers can apply at checkout with percentage or fixed-amount savings. Set up time-limited offers, loyalty rewards, or affiliate codes with optional restrictions by product or redemption limits.

Delete a discount

Remove a discount code from circulation to prevent future redemptions while keeping existing orders intact. Use this to retire expired promotions, remove duplicate codes, or disable compromised discounts.

Get a discount by ID

Retrieve detailed information about a specific discount, including its configuration, redemption limits, and usage statistics. Use this to verify discount settings or display discount details to customers and team members.

List all discounts

Retrieve all your discount codes and promotions organized in a paginated list. Use this to track active discounts, manage promotional campaigns, and see what deals are currently available to your customers.

Update a discount

Modify an existing discount's settings such as expiration date, redemption limits, or product eligibility. This lets you quickly adjust promotional rules without creating new discounts.

Get a dispute by ID

Retrieve detailed information about a specific payment dispute, including the reason, amount, evidence deadline, and current status to investigate and respond to chargebacks.

List all payment disputes

Retrieve a list of payment disputes and chargebacks filed against your account, allowing you to monitor dispute activity and track resolution status.

List event types with statistics

Retrieve all event types with aggregated statistics including event counts and timestamps to understand which events are active in your system.

Update an event type label

Rename how an event type appears in your dashboard and admin interface for better clarity, without affecting the underlying system. Use this to make event names more meaningful and easier to understand at a glance.

Get an event by ID

Retrieve detailed information about a specific event including when it occurred, which customer triggered it, and any associated data. Use this to verify event details, investigate billing discrepancies, or audit customer activity.

List all events

Retrieve a paginated list of events tracked for your organization to monitor usage-based billing and metering data. This helps you verify that your application is sending the correct event data and troubleshoot any billing discrepancies.

List unique event names

Retrieves all distinct event names that have been tracked in your organization, allowing you to discover what events are available and verify your application is sending the correct event types.

Send a batch of usage events

Track and report usage activities from your application to enable accurate usage-based billing and metering. This allows you to measure customer consumption like API calls, compute time, or storage so billing charges reflect actual usage.

Complete a file upload

Finalizes a file upload by confirming that the content has been successfully transferred to the storage location, making the file available for use in your system.

Delete a file

Remove a file from your storage to free up space and clean up outdated or unused media assets.

List all uploaded files

Retrieve all files you've uploaded to your organization, including product media, downloadable assets, and attachments. Use this to organize your file library, display content to customers, or monitor your storage usage.

Update file metadata

Update a file's name, description, or other metadata without re-uploading the actual content. This lets you keep your file library organized and easy to find.

Upload a new file

Prepare a file for upload by creating a file record and receiving a presigned URL where you can store your content. This is the first step in adding product images, digital downloads, or other attachments to your Polar workspace.

Activate a license key server-side

Activate a license key instance from your backend server when a customer purchases or installs your software product. This consumes one activation slot and returns activation details for your records and customer tracking.

Deactivate a license key server-side

Deactivate a license key instance to free up an activation slot, allowing the license to be used on a different device. Use this when you need server-side control over license management, such as when a customer upgrades their device or you're processing license returns.

Get a license key activation

Retrieve detailed information about a specific license key activation, including when it was activated and what device or installation it's associated with. Use this to track and verify which customers or machines are using your licensed software.

Get a license key by ID

Retrieve detailed information about a specific license key, including its validity status, usage count, and associated customer details. Use this to manage licenses, support customer inquiries, and maintain accurate records of your product activations.

List all license keys

Retrieve all license keys issued by your organization to view your complete license inventory and monitor their status across customers and products.

Update a license key

Modify license key properties including activation limits, expiration dates, and status to manage customer access and licensing terms. This lets you extend licenses, accommodate upgrades, or disable compromised keys without issuing new ones.

Validate a license key server-side

Verify that a license key is active and has available activations remaining, ensuring customers have valid access to your product or service.

Create a new member

Invite and add new team members to your organization, enabling you to manage who has access to your workspace and resources.

Get a member by ID

Retrieve detailed information about a specific organization member, including their name, email, and role within your organization.

List organization members

Retrieve all members in your organization with pagination support, allowing you to see who has access to your account and manage team permissions.

Remove a member

Remove a member from your organization and revoke their access to subscriptions and benefits. Use this to offboard team members or manage access changes as your team evolves.

Update a member

Modify a team member's name, role, or permissions within your organization. Use this to update member information, change job titles, or adjust access levels as your team evolves.

Create a new meter

Set up a usage-based billing metric that tracks and aggregates customer activity into measurable quantities for charging purposes. This lets you automatically calculate billing amounts based on how customers actually use your product.

Get a meter by ID

Retrieve detailed information about a specific meter to view its configuration, event filtering rules, and how it's calculating metrics for your products.

Get meter quantities over time

Retrieve aggregated meter quantities over a specified time period, broken down by interval to track and analyze usage patterns. This helps you understand consumption trends and create visualizations of how your customers are using your metered services.

List all meters

Retrieve all usage metrics configured for your organization to see how customer activity is being tracked and billed. This helps you understand your current billing meter setup and manage what you're measuring.

Update a meter

Modify how a meter tracks and aggregates usage data, including its name, event filters, and calculation methods to ensure accurate billing and usage insights.

Get available date range for metrics

Get the available date range for your metrics data, helping you understand what historical data you can query and analyze. Use this to set up date filters in dashboards and reports without requesting unavailable data.

Get revenue and subscription metrics

Get comprehensive revenue and subscription data across your business over any date range, including total earnings, subscriber counts, and key performance metrics. Use this to understand your financial health and track business growth over time.

Delete an OAuth2 client

Removes a registered OAuth2 client and immediately invalidates all tokens associated with it, terminating any active sessions. Use this when shutting down an integration or responding to a security breach.

Exchange grant for access token

Obtain or refresh API access tokens needed to make authenticated requests to Polar's API after a user authorizes your application. This enables your app to securely access Polar data and features on behalf of your users.

Get an OAuth2 client by ID

Retrieve the configuration details of a registered OAuth2 client, including its redirect URIs, scopes, and metadata. This helps you verify client settings and maintain accurate records of your integrations.

Get authenticated user profile

Retrieves the profile information of the currently logged-in user, including their email and name, to identify who authorized access to your application.

Initiate OAuth2 authorization

Redirects users to Polar's consent screen to grant your application permission to access their account, then returns an authorization code your app can exchange for tokens.

Inspect token validity and scopes

Check whether an access token is still valid and see what permissions it has, along with when it expires. This helps you verify that a user is properly authenticated before allowing them to access protected features in your application.

Register an OAuth2 client

Set up a new application that can connect to Polar and access user data through secure login, requiring you to specify where users will be redirected after authentication and what permissions the app needs.

Revoke an access or refresh token

Invalidates an access or refresh token to immediately disconnect a user's account integration or terminate an active session. Revoking a refresh token also invalidates all associated access tokens, providing a clean way to manage authentication state.

Update an OAuth2 client

Modify your OAuth2 client's settings such as redirect URIs and allowed scopes when your integration requirements change or you need to support new environments.

List all orders

Retrieve all completed purchases from your store, including one-time sales and subscription renewals. Use this to view your order history, verify revenue, and automate follow-up actions after customers buy.

Export orders as CSV

Download all your orders in CSV format to use with accounting software, spreadsheets, or financial analysis tools. Perfect for tracking sales data, preparing tax documents, or migrating information to another platform.

Generate an invoice for an order

Create a PDF invoice for a specific order that can be sent to customers or stored for your records. This is useful when you need to provide billing documentation to customers or maintain organized financial records.

Get an order by ID

Retrieve complete details about a specific order including line items, amounts, tax information, customer data, and payment status to verify purchase information or investigate order issues.

Get invoice data for an order

Retrieve complete invoice details for a specific order, including line items, taxes, and seller information to use in your business systems.

Update an order

Modify an order's details such as billing address, internal notes, or custom fields to keep your order information accurate and organized.

Create an organization access token

Generate a reusable access token tied to your organization rather than an individual user, enabling secure programmatic access for automated systems and integrations that persist across team changes.

List organization access tokens

Retrieve all access tokens created for your organization to see which API credentials are active and manage programmatic access. This helps you track and audit which applications or integrations have permission to interact with your organization's data.

Revoke an organization access token

Immediately revoke API access by deleting an organization access token, preventing any further requests from using that credential.

Update an organization access token

Modify a token's permissions, description, or resource access rights without needing to generate a new token. This helps you adjust what actions the token can perform or add notes for easier management.

Create a new organization

Set up a new organization on Polar to establish a top-level account that will manage products, customers, and billing. Use this when bringing on a new seller or launching a separate brand under your platform.

Get an organization by ID

Fetch complete details about a specific organization including its name, configuration, and available features. Use this to verify organization settings and understand what capabilities are enabled before performing operations.

List all organizations

Retrieve all organizations you have access to, useful for displaying organization selection menus or syncing your organizational structure with your application.

Update an organization

Update your organization's core settings including name, branding, billing information, and feature configurations to keep your business details current and manage capabilities.

Get a payment by ID

Retrieve detailed information about a specific payment transaction including its status, amount, and payment method. Use this to verify transaction details, investigate payment issues, or generate payment receipts for customers.

List all payments

Retrieve all payments processed through your organization to track financial transactions and monitor cash flow. This gives you visibility into successful charges, failed payments, and pending transactions for your business.

Create a new product

Add a new product to your catalog with custom pricing, descriptions, and benefits. Use this to launch subscription tiers, one-time purchases, or digital goods that customers can buy.

Get a product by ID

Retrieve detailed information about a specific product including its pricing, benefits, and media to display on your store or verify product details before processing orders.

List all products

Retrieve your complete product catalog to display on your website, pricing pages, or integrate with other business tools. Filter products by type and status to find exactly what you need.

Update a product

Modify your product's details including name, description, pricing, and visibility. Changes take effect immediately for new purchases while preserving existing customer agreements.

Update benefits for a product

Modify the benefits customers receive when they purchase a product, such as access to license keys, files, or integrations. Use this to add, remove, or update what value your customers get after buying.

Issue a refund

Process a refund for a previous customer order by returning funds to their original payment method. Use this to handle customer refund requests, resolve billing issues, or automate refund workflows based on support interactions.

List all refunds

Retrieve all refunds issued by your organization to track refund activity and reconcile your financial records. Use this to monitor customer returns and maintain accurate accounting across your business.

Create a subscription programmatically

Enroll customers directly into free subscriptions without requiring them to go through checkout, ideal for automated provisioning and free tier onboarding.

List all subscriptions

Retrieve all subscriptions across your organization to monitor recurring revenue and customer retention. Use filters to view subscriptions by product, customer, or status for targeted insights.

Export subscriptions as CSV

Download all your subscription data as a CSV file for easy analysis, reporting, and integration with external tools like spreadsheets or accounting software.

Get a subscription by ID

Retrieve complete details about a specific subscription including its status, current period, pricing, and associated customer and product information.

Revoke a subscription immediately

Immediately terminate a customer's subscription and revoke their access, useful for addressing security issues or enforcing account policies right away.

Update a subscription

Modify an active subscription's plan, pricing, or custom attributes to reflect customer changes or business adjustments.

Create a webhook endpoint

Register a URL to receive real-time notifications when subscription, order, or payment events occur in your Polar account. This enables you to automatically sync customer data, trigger workflows, or integrate Polar events with your other business tools.

Delete a webhook endpoint

Permanently remove a webhook endpoint to stop all future event deliveries when you no longer need the integration.

Get a webhook endpoint by ID

Retrieves the configuration details of a specific webhook endpoint, including its URL, subscribed events, and status. Use this to verify your webhook setup is correct or troubleshoot why events aren't being delivered.

List all webhook endpoints

View all webhook endpoints your organization has set up to receive real-time events from Polar. Use this to see which URLs are currently configured to receive notifications and manage your event delivery setup.

List webhook delivery attempts

View all webhook delivery attempts to see which events successfully reached your endpoints and which failed, helping you troubleshoot delivery issues and ensure your integrations are working reliably.

Redeliver a webhook event

Retry sending a failed webhook event to its destination endpoint, useful for recovering from temporary delivery issues or outages without waiting for the next automatic retry attempt.

Rotate webhook signing secret

Regenerate the signing secret used to verify webhook messages from Polar, ensuring your webhook endpoint can securely receive and validate future notifications from the platform.

Update a webhook endpoint

Modify a webhook endpoint's configuration, including its delivery URL, subscribed events, or active status without losing its history or settings.