Polar Integration
Polar API Operations
Browse all 166 operations available for Polar workflow automation.
Benefit-grants
1 operation/v1/benefit-grants/List Benefit Grants
View all the benefits you've granted to customers and supporters across your organization, helping you track who has access to what benefits.
Benefits
6 operations/v1/benefits/Create Benefit
Create a new benefit offering that you can attach to products or subscriptions to provide exclusive perks and value to your customers.
/v1/benefits/{id}Delete Benefit
Permanently removes a benefit offering from your Polar account, which automatically revokes access for all users who previously received it.
/v1/benefits/{id}Get Benefit
Retrieve the details of a specific benefit you've created, including its description, features, and associated products or tiers.
/v1/benefits/{id}/grantsList Benefit Grants
Retrieve all individual grants for a specific benefit to verify which users have access to it. Use this to audit benefit distribution and manage user entitlements across your membership or subscription program.
/v1/benefits/List Benefits
Retrieve all benefits you've created for your products or services to view their names, descriptions, and availability status in one place.
/v1/benefits/{id}Update Benefit
Modify the details of an existing benefit such as its name, description, or availability settings to keep your offerings current and aligned with your business goals.
Checkout-links
5 operations/v1/checkout-links/Create Checkout Link
Generate a shareable checkout link for your products or services that customers can use to make purchases without leaving your website or marketing materials. This allows you to embed payment collection directly into emails, social media, and promotional content.
/v1/checkout-links/{id}Delete Checkout Link
Remove a checkout link you no longer need, instantly disabling it so customers can't make purchases through that specific link. Use this when you've closed a sale, ended a promotion, or want to clean up outdated payment pages.
/v1/checkout-links/{id}Get Checkout Link
Retrieve the details and current status of a specific checkout link you've created, including its configuration, performance metrics, and whether it's active or expired.
/v1/checkout-links/List Checkout Links
Retrieve all checkout links you've created for selling products and subscriptions, allowing you to manage and review your sales channels in one place.
/v1/checkout-links/{id}Update Checkout Link
Modify an existing checkout link's settings, pricing, or product details to reflect current offerings or business changes without needing to create a new link.
Checkouts
7 operations/v1/checkouts/client/{client_secret}/confirmConfirm Checkout Session from Client
Complete a checkout session using the client secret to process orders and subscriptions on your storefront or custom checkout page.
/v1/checkouts/Create Checkout Session
Set up a checkout session to collect payments from customers for your products or services. This creates a secure payment flow that handles transaction processing and customer data.
/v1/checkouts/{id}Get Checkout Session
Retrieve the details of a specific checkout session to view payment status, customer information, and transaction data.
/v1/checkouts/client/{client_secret}Get Checkout Session from Client
Retrieve checkout session details using a client secret to verify payment status and session information after a customer initiates a purchase.
/v1/checkouts/List Checkout Sessions
Retrieve all checkout sessions created for your products and subscriptions, allowing you to view and analyze customer purchase activity and conversion data.
/v1/checkouts/{id}Update Checkout Session
Modify an existing checkout session to update pricing, discount codes, customer information, or other session details before the customer completes their purchase.
/v1/checkouts/client/{client_secret}Update Checkout Session from Client
Modify an active checkout session using the client secret to update customer information, prices, or product selections before payment is completed.
Custom-fields
5 operations/v1/custom-fields/Create Custom Field
Add a custom field to your Polar workspace to capture and store additional information that matters to your business beyond standard data fields.
/v1/custom-fields/{id}Delete Custom Field
Remove a custom field from your Polar workspace when it's no longer needed, immediately stopping its use across all associated records and workflows.
/v1/custom-fields/{id}Get Custom Field
Retrieve the details and configuration of a specific custom field you've set up in your Polar workspace. Use this to access field properties like name, type, and settings without listing all custom fields.
/v1/custom-fields/List Custom Fields
Retrieve all custom fields available in your Polar workspace to understand what additional information you can collect from customers and donors. This helps you see your entire data collection setup at a glance.
/v1/custom-fields/{id}Update Custom Field
Modify the settings and configuration of an existing custom field to keep your customer data structure aligned with your business needs.
Customer-seats
6 operations/v1/customer-seatsAssign Seat
Allocates a customer seat license to enable a user to access your product or service within their subscription. Use this when you need to grant access to a specific team member or collaborator.
/v1/customer-seats/claimClaim Seat
Assign a subscription seat to a customer, enabling them to access your product or service as part of their subscription tier. This is essential for managing who has active access within a subscription.
/v1/customer-seats/claim/{invitation_token}Get Claim Info
Retrieve details about a customer seat claim using an invitation token, allowing you to verify claim status and user information before completing the seat assignment.
/v1/customer-seatsList Seats
Retrieves a list of all customer seats or licenses you've assigned to your customers, allowing you to track who has access to your product and their current status.
/v1/customer-seats/{seat_id}/resendResend Invitation
Resend a seat invitation to a customer who hasn't yet accepted their access. Use this when an invitation email may have been missed, deleted, or needs to be sent to a customer again.
/v1/customer-seats/{seat_id}Revoke Seat
Remove a team member's access to your Polar account by revoking their assigned seat. This frees up that seat license for another team member or reduces your subscription costs.
Customer-sessions
1 operation/v1/customer-sessions/Create Customer Session
Establishes a secure session for a customer to access their account or content, enabling authenticated interactions with your platform. This allows you to manage customer access and track their engagement with your products or services.
Customer_meters
2 operations/v1/customer-meters/{id}Get Customer Meter
Retrieve detailed information about a specific customer's usage meter, including current consumption data and metrics tracked for billing or service delivery purposes.
/v1/customer-meters/List Customer Meters
Retrieve all metered usage records for your customers to monitor consumption patterns and track their product usage over time. This helps you understand customer engagement and usage trends for billing or analytics purposes.
Customer_portal
38 operations/v1/customer-portal/license-keys/activateActivate License Key
Enables customers to activate their license keys directly from your application or website, allowing them to unlock premium features or extend their access. This is ideal for self-service activations in client-side applications where you want customers to manage their own licenses.
/v1/customer-portal/customers/me/payment-methodsAdd Customer Payment Method
Allows customers to securely add a new payment method (credit card, bank account, etc.) to their account for future transactions and subscriptions.
/v1/customer-portal/seatsAssign Seat
Allocate a subscription seat to a team member or customer, enabling them to access your product or service with their own credentials and usage tracking.
/v1/customer-portal/subscriptions/{id}Cancel Subscription
Allows you to cancel an active subscription for your customer through your customer portal, immediately stopping future billing and access.
/v1/customer-portal/customers/me/payment-methods/confirmConfirm Customer Payment Method
Verify that a customer's payment method (such as a credit card) is valid and working before processing charges. This ensures you can reliably collect payments from your customers.
/v1/customer-portal/orders/{id}/confirm-paymentConfirm Retry Payment
Complete a payment retry for a customer order by confirming their Stripe payment details, allowing them to resolve failed transactions without having to re-enter their information.
/v1/customer-portal/license-keys/deactivateDeactivate License Key
Allows customers to disable an active license key from your application without needing to log in, making it easy to manage their licenses from desktop or mobile clients.
/v1/customer-portal/customers/me/payment-methods/{id}Delete Customer Payment Method
Remove a payment method from your customer account, allowing you to delete outdated or unused payment information.
/v1/customer-portal/orders/{id}/invoiceGenerate Order Invoice
Creates and generates an invoice document for a specific customer order, making it available for download or sharing with customers.
/v1/customer-portal/customer-session/userGet Authenticated Portal User
Retrieve details about the customer who is currently logged into your customer portal, including their profile information and account status.
/v1/customer-portal/benefit-grants/{id}Get Benefit Grant
Retrieve the details of a specific benefit grant that belongs to the authenticated customer, including its status and terms.
/v1/customer-portal/customers/meGet Customer
Retrieves the authenticated customer's profile information including account details, subscription status, and personal data from Polar. This helps you access and verify customer account information whenever needed.
/v1/customer-portal/meters/{id}Get Customer Meter
Retrieve detailed information about a specific usage meter associated with your account, allowing you to track and monitor billing metrics in real-time.
/v1/customer-portal/license-keys/{id}Get License Key
Retrieve the details of a specific license key, including its activation status, expiration date, and associated product information. Use this to verify customer licenses and manage access to your protected software or services.
/v1/customer-portal/orders/{id}Get Order
Retrieve detailed information about a specific customer order, including items, pricing, and status. This helps you look up order details to respond to customer inquiries or verify transaction information.
/v1/customer-portal/orders/{id}/invoiceGet Order Invoice
Retrieve the invoice details for a specific customer order, including amounts, items, and payment information for record-keeping or customer communication.
/v1/customer-portal/orders/{id}/payment-statusGet Order Payment Status
Check the current payment status of a customer's order to see if payment has been received, is pending, or has failed. This helps you track transaction completion and take appropriate follow-up actions.
/v1/customer-portal/organizations/{slug}Get Organization
Retrieves detailed information about your organization using its unique slug identifier, including branding, settings, and configuration details that appear on your customer portal.
/v1/customer-portal/subscriptions/{id}Get Subscription
Retrieve detailed information about a specific customer subscription, including its status, billing cycle, and plan details. This helps you understand what products or services a customer currently has active.
/v1/customer-portal/wallets/{id}Get Wallet
Retrieve detailed information about a specific wallet belonging to an authenticated customer, including balance and transaction history. This helps you monitor customer funds and payment status in real-time.
/v1/customer-portal/customer-session/introspectIntrospect Customer Session
Retrieve information about the current customer session to understand who is logged in and their status. This helps you verify session validity and access customer details without requiring a new login.
/v1/customer-portal/benefit-grants/List Benefit Grants
Retrieve all benefits and grants that your customers have earned or are eligible for through their account. This helps you understand what perks and rewards your paying customers currently have access to.
/v1/customer-portal/seats/subscriptionsList Claimed Subscriptions
Retrieve all subscriptions where the authenticated customer currently has an active claimed seat, allowing you to see which products or services you're entitled to use.
/v1/customer-portal/customers/me/payment-methodsList Customer Payment Methods
Retrieve all saved payment methods for the authenticated customer, allowing you to see what cards or payment options are on file for streamlined transactions.
/v1/customer-portal/downloadables/List Downloadables
Retrieves a list of downloadable files and resources available to customers through the customer portal, such as guides, templates, or product files. Use this to display or manage the digital assets your customers can access.
/v1/customer-portal/license-keys/List License Keys
Retrieve all license keys associated with a customer account, allowing you to view and manage software licenses tied to their purchases or subscriptions.
/v1/customer-portal/meters/List Meters
Retrieve all usage meters tracked for your customer account, allowing you to monitor consumption metrics and billing data in real-time.
/v1/customer-portal/orders/List Orders
Retrieve a complete list of all orders placed by a customer, allowing you to display purchase history and order details in your customer portal or dashboard.
/v1/customer-portal/seatsList Seats
Retrieves a list of all seats associated with your subscription, showing which team members have access and their current status. Use this to manage your team's subscription allocations and monitor seat usage.
/v1/customer-portal/subscriptions/List Subscriptions
Retrieve all active and past subscriptions for your authenticated customer account, allowing you to manage and track their subscription history in your system.
/v1/customer-portal/wallets/List Wallets
Retrieve all cryptocurrency wallets connected to a customer account, allowing visibility into all stored digital assets and their balances.
/v1/customer-portal/seats/{seat_id}/resendResend Invitation
Sends a new invitation link to a team member who hasn't yet accepted their seat, allowing them to join your organization without needing to create a new seat.
/v1/customer-portal/seats/{seat_id}Revoke Seat
Remove access for a specific team member or user from your organization's account and resources. This immediately revokes their seat license and prevents them from accessing any shared content or collaboration features.
/v1/customer-portal/benefit-grants/{id}Update Benefit Grant
Modify the details of a benefit grant that's been issued to a customer, such as updating expiration dates or redemption terms. This lets you adjust customer benefits as circumstances change without recreating the entire grant.
/v1/customer-portal/customers/meUpdate Customer
Modify your customer profile information such as name, email, or billing details directly through the customer portal. This lets you keep your account details current without contacting support.
/v1/customer-portal/orders/{id}Update Order
Modify the details of an existing order in your customer portal, such as updating quantities, shipping information, or other order specifics for your customers.
/v1/customer-portal/subscriptions/{id}Update Subscription
Modify an existing customer subscription to change plans, update billing details, or adjust subscription settings. This lets you help customers manage their own subscriptions without manual intervention.
/v1/customer-portal/license-keys/validateValidate License Key
Verify that a license key is valid and active without exposing sensitive server credentials, making it ideal for client-side validation in desktop or mobile applications.
Customers
11 operations/v1/customers/Create Customer
Register a new customer in your Polar account to start tracking their purchases and managing their subscription lifecycle. This enables you to organize customer data and understand your revenue streams.
/v1/customers/{id}Delete Customer
Permanently removes a customer account and cancels all their active subscriptions and benefits in one action. Use this when a customer requests deletion or you need to remove a user from your service.
/v1/customers/external/{external_id}Delete Customer by External ID
Removes a customer from your system and immediately cancels their active subscriptions and benefits. Use the anonymize option to comply with data privacy regulations by removing personally identifiable information.
/v1/customers/exportExport Customers
Download your complete customer list as a CSV file for analysis, reporting, or integration with other business tools.
/v1/customers/{id}Get Customer
Retrieve detailed information about a specific customer by their ID, including their profile data, subscription status, and purchase history. Use this to access customer details for support, fulfillment, or personalization purposes.
/v1/customers/{id}/stateGet Customer State
Retrieve a customer's current status including their active subscriptions and benefits to get a complete overview of their account. Use this to make informed decisions about customer engagement, support, or service delivery.
/v1/customers/external/{external_id}/stateGet Customer State by External ID
Retrieve a customer's current subscription status and active benefits using their external ID, giving you a complete snapshot of their relationship with your business.
/v1/customers/external/{external_id}Get Customer by External ID
Retrieve a customer's profile and details using an external identifier you've assigned, such as a customer ID from your own system or third-party platform. This helps you quickly access customer information without needing to search by email or internal Polar ID.
/v1/customers/List Customers
Retrieve a list of all your customers to view their profiles, purchase history, and subscription status in one place.
/v1/customers/{id}Update Customer
Modify customer information such as name, email, or metadata to keep your customer records accurate and up-to-date. This ensures your customer data reflects the latest information for better communication and record-keeping.
/v1/customers/external/{external_id}Update Customer by External ID
Modify customer information using an external identifier you've assigned, allowing you to keep your customer records in sync across systems without managing Polar's internal IDs.
Discounts
5 operations/v1/discounts/Create Discount
Create a discount code or promotional offer for your products or subscriptions, allowing you to set specific discount amounts, percentages, or usage limits.
/v1/discounts/{id}Delete Discount
Remove a discount code from your store when it's no longer needed or has expired. This permanently deletes the discount so customers can no longer apply it at checkout.
/v1/discounts/{id}Get Discount
Retrieve detailed information about a specific discount including its terms, usage limits, and redemption status.
/v1/discounts/List Discounts
Retrieve all discounts you've created to view their details, usage status, and current settings. This helps you manage promotional offers and track which discounts are active across your products.
/v1/discounts/{id}Update Discount
Modify an existing discount's details such as code, percentage, duration, or applicable products to keep your promotional offers current and effective.
Disputes
2 operations/v1/disputes/{id}Get Dispute
Retrieve detailed information about a specific dispute, including its status, reason, and timeline, so you can track and manage customer payment issues or chargeback claims.
/v1/disputes/List Disputes
Retrieve a complete list of all disputes associated with your Polar account to monitor payment conflicts and customer issues.
Event-types
2 operations/v1/event-types/List Event Types
Retrieve all available event types with aggregated statistics to understand what events are tracked in your account. This helps you identify which events are most important to your business and how they're performing.
/v1/event-types/{id}Update Event Type
Modify the label and details of an existing event type to keep your scheduling options current and aligned with your business needs.
Events
4 operations/v1/events/{id}Get Event
Retrieve detailed information about a specific event using its ID, including event details, metadata, and associated data. This helps you access event information programmatically for display, integration, or management purposes.
/v1/events/ingestIngest Events
Send multiple events to Polar in a single batch request, enabling you to record customer actions, subscriptions, or transactions efficiently without making individual API calls.
/v1/events/namesList Event Names
Retrieve a list of all available event types in your Polar account so you can understand what events are being tracked and triggered by your products or services.
/v1/events/List Events
Retrieve a list of all events from your Polar account to view, filter, and manage your community activities and customer engagement records.
Files
5 operations/v1/files/{id}/uploadedComplete File Upload
Notify the system that a file has finished uploading so it can be processed and made available for use in your application or workflow.
/v1/files/Create File
Upload and store files in your Polar account to organize digital assets, documents, or resources for your products and customers. This enables you to centralize file management and make content easily accessible across your business operations.
/v1/files/{id}Delete File
Permanently removes a file from your Polar account, freeing up storage space and ensuring outdated or sensitive content is no longer accessible.
/v1/files/List Files
Retrieve all files you've uploaded to your Polar account so you can organize, track, and manage your digital assets in one place.
/v1/files/{id}Update File
Modify an existing file's properties such as name, description, or metadata to keep your file organization up-to-date without replacing the entire file.
License_keys
7 operations/v1/license-keys/activateActivate License Key
Enables a license key so customers can start using your software product or service. This is essential when you're ready to grant access to a new customer after they've completed purchase or setup.
/v1/license-keys/deactivateDeactivate License Key
Disable an active license key to prevent further use without permanently deleting it, useful for managing access when customers cancel or when you need to revoke permissions temporarily.
/v1/license-keys/{id}/activations/{activation_id}Get Activation
Retrieve detailed information about a specific license activation, including its status, activation date, and associated device details.
/v1/license-keys/{id}Get License Key
Retrieve details of a specific license key, including its status, expiration date, and usage information to verify activation and entitlement status.
/v1/license-keys/List License Keys
Retrieve all license keys associated with your organization, optionally filtered by specific criteria to find particular licenses or activation statuses. This helps you manage and monitor which licenses are active, inactive, or assigned to specific customers.
/v1/license-keys/{id}Update License Key
Modify an existing license key's settings, such as expiration date, limits, or activation status, to manage your software licensing without creating a new key.
/v1/license-keys/validateValidate License Key
Verifies whether a license key is valid and active, allowing you to check customer licenses in real-time before granting access to your product or service.
Member-sessions
1 operation/v1/member-sessions/Create Member Session
Initiates a new member session for organizations using seat-based pricing, enabling you to track and manage individual member access and activity.
Members
5 operations/v1/members/Create Member
Add a new team member to a customer account so they can access and collaborate within your platform.
/v1/members/{id}Delete Member
Remove a member from your organization, immediately revoking their access to all team resources and collaborative features.
/v1/members/{id}Get Member
Retrieve detailed information about a specific member in your organization by their ID. Use this to access member profiles, contact details, and membership status for individual team members or customers.
/v1/members/List Members
Retrieve a list of all members in your Polar account, with optional filtering by customer ID to find specific members. Use this to view, analyze, and manage your community or subscriber base.
/v1/members/{id}Update Member
Modify a team member's name or role within your organization to keep your team structure current and reflect changing responsibilities.
Meters
5 operations/v1/meters/Create Meter
Set up a new meter to track and measure specific metrics or usage events in your business, such as API calls, feature usage, or customer activity.
/v1/meters/{id}Get Meter
Retrieve detailed information about a specific meter, including its current readings and configuration details. This helps you monitor and track individual meter performance in your system.
/v1/meters/{id}/quantitiesGet Meter Quantities
Retrieve the quantity measurements for a specific meter over a defined time period to track consumption, usage, or production metrics.
/v1/meters/List Meters
Retrieve all meters configured in your account to view and manage your usage tracking metrics. This helps you monitor what you're measuring and ensure all your key metrics are properly set up.
/v1/meters/{id}Update Meter
Modify the configuration and settings of an existing meter to track usage metrics in real-time. Use this to adjust billing thresholds, update tracking parameters, or change how you measure customer consumption.
Metrics
2 operations/v1/metrics/Get Metrics
Retrieve metrics data about your orders and subscriptions to monitor sales performance and revenue trends. Use this to track key business metrics across your products and understand customer purchase patterns.
/v1/metrics/limitsGet Metrics Limits
Check the rate limits and data refresh intervals for your metrics API requests so you can plan your data collection and avoid hitting usage caps.
Oauth2
9 operations/v1/oauth2/authorizeAuthorize
Initiates the authorization flow to securely connect your application with Polar, allowing users to grant access to their account information and perform actions on their behalf.
/v1/oauth2/registerCreate Client
Register a new OAuth2 application to enable secure third-party integrations with your Polar account. This allows other apps and services to request permission to access your data on your behalf.
/v1/oauth2/register/{client_id}Delete Client
Remove an OAuth2 client registration from your Polar account when you no longer need an application to access your data. This is useful for cleaning up old integrations or revoking access from third-party tools.
/v1/oauth2/register/{client_id}Get Client
Retrieve the details of an OAuth2 application you've registered, including its configuration and credentials.
/v1/oauth2/userinfoGet User Info
Retrieves the profile information of the currently authenticated user, including their name, email, and account details.
/v1/oauth2/introspectIntrospect Token
Verify the validity and details of an access token to ensure it's active and retrieve its associated user or application information.
/v1/oauth2/tokenRequest Token
Exchange your authorization credentials for an access token that allows your application to interact with the Polar API on behalf of your account. This is the essential first step in authenticating your integration.
/v1/oauth2/revokeRevoke Token
Invalidates an access token or refresh token to immediately revoke a user's access to your application. Use this when you need to disconnect a user's account or end their session.
/v1/oauth2/register/{client_id}Update Client
Modify the settings and configuration of an existing OAuth2 application, such as updating redirect URLs, display names, or access permissions without creating a new app.
Orders
6 operations/v1/orders/exportExport Subscriptions
Download your subscription orders as a CSV file for analysis, reporting, or import into other business tools.
/v1/orders/{id}/invoiceGenerate Order Invoice
Generate a formal invoice document for a customer order that can be downloaded, shared, or stored for accounting and record-keeping purposes.
/v1/orders/{id}Get Order
Retrieve detailed information about a specific order using its ID, including customer details, items purchased, and payment status. This helps you quickly access and review individual transaction records.
/v1/orders/{id}/invoiceGet Order Invoice
Retrieve the invoice details for a specific order, including amounts, items, and customer information for record-keeping and financial tracking.
/v1/orders/List Orders
Retrieve a list of all orders placed by customers, allowing you to view transaction history and monitor sales activity in one place.
/v1/orders/{id}Update Order
Modify order details such as customer information, items, pricing, or status after an order has been created, allowing you to correct errors or adjust orders based on customer requests.
Organization_access_tokens
4 operations/v1/organization-access-tokens/Create
Generate secure access tokens for programmatic interactions with your organization's Polar account, enabling automated workflows and integrations without exposing your main credentials.
/v1/organization-access-tokens/{id}Delete
Remove an access token from your organization to revoke API access for integrations or applications that are no longer needed or have been compromised.
/v1/organization-access-tokens/List
Retrieve all access tokens created for your organization to manage API authentication and integrations. Use this to audit which tokens exist, track their creation dates, and identify active authentication methods.
/v1/organization-access-tokens/{id}Update
Modify an existing organization access token's settings, such as expiration date or permissions scope. Use this to update security credentials without needing to create new tokens.
Organizations
4 operations/v1/organizations/Create Organization
Set up a new organization to manage your products, subscriptions, and team members in one centralized workspace.
/v1/organizations/{id}Get Organization
Retrieve detailed information about a specific organization using its unique identifier, such as name, settings, and profile details.
/v1/organizations/List Organizations
Retrieve a list of all organizations you manage or belong to, helping you quickly access organization details and settings across your business accounts.
/v1/organizations/{id}Update Organization
Modify your organization's details such as name, settings, and profile information to keep your business information current and accurate.
Payments
2 operations/v1/payments/{id}Get Payment
Retrieve detailed information about a specific payment transaction by its ID, including payment status, amount, and customer details. This allows you to verify payment details and track transaction history.
/v1/payments/List Payments
Retrieve a list of all payments received from your customers, allowing you to view transaction history and track incoming revenue. This helps you understand your cash flow and verify that payments have been successfully processed.
Products
5 operations/v1/products/Create Product
Add a new product to your Polar store that customers can purchase, download, or subscribe to. This lets you list your digital offerings and start generating revenue.
/v1/products/{id}Get Product
Retrieve detailed information about a specific product by its ID, including pricing, description, and inventory details. This helps you access product data for display, verification, or integration with other business systems.
/v1/products/List Products
Retrieve all products you've created in your Polar store, including details about pricing, inventory, and availability to manage your product catalog.
/v1/products/{id}Update Product
Modify an existing product's details such as name, description, pricing, or status to keep your offering current and aligned with your business needs.
/v1/products/{id}/benefitsUpdate Product Benefits
Modify the perks, features, or benefits that customers receive when they purchase a product, such as access to exclusive content, support tiers, or digital resources.
Refunds
2 operations/v1/refunds/Create Refund
Issue a refund for a customer purchase, allowing you to return funds for orders or subscriptions that need to be reversed.
/v1/refunds/List Refunds
Retrieve all refunds issued in your Polar account to see transaction reversals and refund activity over time. Use this to track customer refunds, monitor refund patterns, and reconcile your refund records.
Subscriptions
6 operations/v1/subscriptions/Create Subscription
Programmatically create subscriptions for free products in your Polar store without triggering checkout flows or confirmation emails. Use this when you need to set up subscriber relationships directly through your own application or system.
/v1/subscriptions/exportExport Subscriptions
Download all your subscription data in CSV format for analysis, reporting, or integration with other business tools. This allows you to easily access and manage your customer subscription information outside of Polar.
/v1/subscriptions/{id}Get Subscription
Retrieve detailed information about a specific subscription including its status, pricing, and customer details. Use this to check subscription health and manage your revenue-generating customers.
/v1/subscriptions/List Subscriptions
Retrieve a list of all subscriptions associated with your products, showing active and inactive customer subscriptions. This helps you track recurring revenue and monitor customer subscription status.
/v1/subscriptions/{id}Revoke Subscription
Immediately cancel a customer's active subscription, preventing further charges and access. Use this when a customer requests cancellation or you need to terminate their service right away.
/v1/subscriptions/{id}Update Subscription
Modify subscription details such as billing cycle, amount, or status to adapt to changing customer needs without interrupting service.
Webhooks
8 operations/v1/webhooks/endpointsCreate Webhook Endpoint
Register a new webhook endpoint to receive real-time notifications about events in your Polar account, such as new subscriptions or payment updates. This allows you to automatically trigger actions in other tools and systems without manual intervention.
/v1/webhooks/endpoints/{id}Delete Webhook Endpoint
Remove a webhook endpoint from your Polar account when you no longer need to receive real-time notifications about events like new subscriptions or updates.
/v1/webhooks/endpoints/{id}Get Webhook Endpoint
Retrieves the configuration details of a specific webhook endpoint to view its settings, URL, and event subscriptions. This helps you verify or audit your webhook integrations with Polar.
/v1/webhooks/deliveriesList Webhook Deliveries
View all attempts to deliver webhook events to your endpoints, helping you track which notifications were successfully sent and identify any delivery failures.
/v1/webhooks/endpointsList Webhook Endpoints
View all webhook endpoints you've configured to receive real-time notifications about events in your Polar account. This helps you manage and monitor which systems are connected to receive updates about subscriptions, payments, and other important activities.
/v1/webhooks/events/{id}/redeliverRedeliver Webhook Event
Triggers a retry of a previously failed webhook event, allowing you to recover from temporary delivery issues without manually recreating the original event.
/v1/webhooks/endpoints/{id}/secretReset Webhook Endpoint Secret
Regenerate the secret key used to verify webhook authenticity from Polar, useful when the current secret may have been compromised or exposed.
/v1/webhooks/endpoints/{id}Update Webhook Endpoint
Modify an existing webhook endpoint's configuration, such as URL, event types, or active status, to ensure your integrations stay aligned with your current business needs.