Your AI team, working in Polar

Polar is a merchant-of-record platform for products, checkouts, customers, subscriptions, orders, benefits, and metrics.

Start your company

What your team can do in Polar

134 tools to work with, connected with an API key.

Accept Dispute

Accept a dispute, permanently conceding the chargeback and settling it as lost. Organization Access Token permissions: `disputes:write`.

Activate License Key

Activate a license key instance. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `license_keys:write`.

Activate License Key

Activate a license key instance. This consumes an activation slot until the instance is deactivated.

Assign Seat

Assign a customer seat. By default this sends an invitation email; set immediate_claim to true to claim the seat without emailing. Verify the target before assigning access.

Complete File Upload

Complete a file upload. Organization Access Token permissions: `files:write`.

Confirm Checkout Session from Client

Confirm a checkout session by client secret. This may trigger payment or finalize an existing transaction.

Create Benefit

Create a benefit, for example license keys, file downloads or Discord access. Organization Access Token permissions: `benefits:write`.

Create Checkout Link

Create a checkout link. Organization Access Token permissions: `checkout_links:write`.

Create Checkout Session

Create a checkout session. Organization Access Token permissions: `checkouts:write`.

Create Custom Field

Create an organization custom field for collecting structured customer or checkout data.

Create Customer

Create a customer. Organization Access Token permissions: `customers:write`.

Create Customer Member

Add a member to a customer by UUID. This grants customer access, so verify the identity and intended role first. Organization Access Token permissions: `members:write`.

Create Customer Member by External ID

Add a member to a uniquely identified external customer. This grants customer access, so verify the customer, identity, and intended role first. Organization Access Token permissions: `members:write`.

Create Discount

Create a discount. Organization Access Token permissions: `discounts:write`.

Create File

Create a Polar file record and obtain multipart upload details. Organization Access Token permissions: `files:write`.

Create Meter

Create a meter. Organization Access Token permissions: `meters:write`.

Create Metric Dashboard

Create a user-defined metric dashboard. Organization Access Token permissions: `metrics:write`.

Create Order

Create a draft order for an off-session charge against a saved payment Organization Access Token permissions: `orders:write`.

Create Organization

Create an organization using OAuth2 with the organizations:write scope.

Create Product

Create a product. Organization Access Token permissions: `products:write`.

Create Refund

Create a refund. Organization Access Token permissions: `refunds:write`.

Create Subscription

Create a subscription for an existing customer to a free recurring product, identified by Polar customer ID or external customer ID. Organization Access Token permissions: `subscriptions:write`.

Create Webhook Endpoint

Create a webhook endpoint. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `webhooks:write`.

Deactivate License Key

Deactivate a license key instance. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `license_keys:write`.

Deactivate License Key

Deactivate a license key instance. The identified installation immediately loses its activation.

Delete Benefit

Delete a benefit. This also revokes every associated grant and removes user access. Organization Access Token permissions: `benefits:write`.

Delete Checkout Link

Delete a checkout link. Organization Access Token permissions: `checkout_links:write`.

Delete Custom Field

Permanently delete a custom field by ID. Verify the field before deletion.

Delete Customer

Delete a customer. Organization Access Token permissions: `customers:write`.

Delete Customer by External ID

Delete a customer by external ID. Organization Access Token permissions: `customers:write`.

Delete Customer Member

Permanently remove a member by customer UUID and member UUID. Use only for a disposable or explicitly confirmed member; never remove the sole owner or an unverified shared member. Organization Access Token permissions: `members:write`.

Delete Customer Member by External ID

Permanently remove a member by customer and member external IDs. Verify both targets and use only for a disposable or explicitly confirmed member; never remove the sole owner or an unverified shared member. Organization Access Token permissions: `members:write`.

Delete Discount

Delete a discount. Organization Access Token permissions: `discounts:write`.

Delete File

Delete a file. Organization Access Token permissions: `files:write`.

Delete Metric Dashboard

Delete a user-defined metric dashboard. Organization Access Token permissions: `metrics:write`.

Delete Product

Delete a product. Organization Access Token permissions: `products:write`.

Delete Webhook Endpoint

Delete a webhook endpoint. Organization Access Token permissions: `webhooks:write`.

Export CustomersReads only

Export customers as a CSV file. Organization Access Token permissions: `customers:read` or `customers:write`.

Export MetricsReads only

Export metrics as a CSV file. Organization Access Token permissions: `metrics:read`.

Export OrdersReads only

Export orders as a CSV file. Organization Access Token permissions: `orders:read`.

Export SubscriptionsReads only

Export subscriptions as a CSV file. Organization Access Token permissions: `subscriptions:read` or `subscriptions:write`.

Finalize Order

Finalize a draft order and synchronously attempt an off-session charge. This may trigger payment or finalize an existing transaction. Organization Access Token permissions: `orders:write`.

Generate Order Invoice

Trigger generation of an order's invoice. Organization Access Token permissions: `orders:read`.

Get ActivationReads only

Get a license key activation. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `license_keys:read` or `license_keys:write`.

Get BenefitReads only

Get a benefit by ID. Organization Access Token permissions: `benefits:read` or `benefits:write`.

Get Checkout LinkReads only

Get a checkout link by ID. Organization Access Token permissions: `checkout_links:read` or `checkout_links:write`.

Get Checkout SessionReads only

Get a checkout session by ID. Organization Access Token permissions: `checkouts:read` or `checkouts:write`.

Get Checkout Session from ClientReads only

Get a checkout session by client secret.

Get Custom FieldReads only

Get one organization custom field and its validation settings by ID.

Get CustomerReads only

Get a customer by ID. Organization Access Token permissions: `customers:read` or `customers:write`.

Get Customer by External IDReads only

Get a customer by external ID. Organization Access Token permissions: `customers:read` or `customers:write`.

Get Customer MemberReads only

Get a member by customer UUID and member UUID without changing membership. Organization Access Token permissions: `members:read` or `members:write`.

Get Customer Member by External IDReads only

Get a member by customer and member external IDs without changing membership. The customer external ID must be unique across accessible organizations. Organization Access Token permissions: `members:read` or `members:write`.

Get Customer MeterReads only

Get a customer meter by ID. Organization Access Token permissions: `customer_meters:read`.

Get Customer StateReads only

Get a customer state by ID. Organization Access Token permissions: `customers:read` or `customers:write`.

Get Customer State by External IDReads only

Get a customer state by external ID. Organization Access Token permissions: `customers:read` or `customers:write`.

Get DiscountReads only

Get a discount by ID. Organization Access Token permissions: `discounts:read` or `discounts:write`.

Get DisputeReads only

Get a payment dispute by ID. Organization Access Token permissions: `disputes:read` or `disputes:write`.

Get EventReads only

Get an event by ID. Organization Access Token permissions: `events:read` or `events:write`.

Get License KeyReads only

Get a license key. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `license_keys:read` or `license_keys:write`.

Get MeterReads only

Get a meter by ID. Organization Access Token permissions: `meters:read` or `meters:write`.

Get Meter QuantitiesReads only

Get quantities of a meter over a time period. Organization Access Token permissions: `meters:read` or `meters:write`.

Get Metric DashboardReads only

Get a user-defined metric dashboard by ID. Organization Access Token permissions: `metrics:read`.

Get MetricsReads only

Get metrics about your orders and subscriptions. Organization Access Token permissions: `metrics:read`.

Get Metrics LimitsReads only

Get the interval limits for the metrics endpoint. Organization Access Token permissions: `metrics:read`.

Get OrderReads only

Get an order by ID. Organization Access Token permissions: `orders:read`.

Get Order InvoiceReads only

Get an order's invoice data. Organization Access Token permissions: `orders:read`.

Get Order ReceiptReads only

Get an order's presigned receipt PDF URL, which is null while the receipt is being generated. Organization Access Token permissions: `orders:read`.

Get OrganizationReads only

Get an organization by ID. Organization Access Token permissions: `organizations:read` or `organizations:write`.

Get OrganizationReads only

Get a customer portal's organization by slug.

Get PaymentReads only

Get a payment by ID. Organization Access Token permissions: `payments:read`.

Get ProductReads only

Get a product by ID. Organization Access Token permissions: `products:read` or `products:write`.

Get SubscriptionReads only

Get a subscription by ID. Organization Access Token permissions: `subscriptions:read` or `subscriptions:write`.

Get Webhook EndpointReads only

Get a webhook endpoint by ID. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `webhooks:read` or `webhooks:write`.

Ingest Events

Ingest batch of events. Organization Access Token permissions: `events:write`.

List Benefit FilesReads only

List the downloadable files for a benefit with their download statistics. Organization Access Token permissions: `benefits:read` or `benefits:write`.

List Benefit GrantsReads only

List benefit grants across all benefits accessible to the authenticated subject. Organization Access Token permissions: `benefits:read` or `benefits:write`.

List Benefit GrantsReads only

List the individual grants for a benefit. Organization Access Token permissions: `benefits:read` or `benefits:write`.

List BenefitsReads only

List benefits. Organization Access Token permissions: `benefits:read` or `benefits:write`.

List Checkout LinksReads only

List checkout links. Organization Access Token permissions: `checkout_links:read` or `checkout_links:write`.

List Checkout SessionsReads only

List checkout sessions. Organization Access Token permissions: `checkouts:read` or `checkouts:write`.

List Custom FieldsReads only

List custom data fields configured for an organization and their validation settings.

List Customer MembersReads only

List members of a customer by UUID without changing membership. Organization Access Token permissions: `members:read` or `members:write`.

List Customer Members by External IDReads only

List members of a uniquely identified external customer without changing membership. Organization Access Token permissions: `members:read` or `members:write`.

List Customer MetersReads only

List customer meters. Organization Access Token permissions: `customer_meters:read`.

List Customer Payment MethodsReads only

Get saved payment methods of a customer. Organization Access Token permissions: `customers:read` or `customers:write`.

List Customer Payment Methods by External IDReads only

Get saved payment methods of a customer by external ID. Organization Access Token permissions: `customers:read` or `customers:write`.

List CustomersReads only

List customers. Organization Access Token permissions: `customers:read` or `customers:write`.

List DiscountsReads only

List discounts. Organization Access Token permissions: `discounts:read` or `discounts:write`.

List DisputesReads only

List payment disputes. Organization Access Token permissions: `disputes:read` or `disputes:write`.

List Event NamesReads only

List event names. Organization Access Token permissions: `events:read` or `events:write`.

List Event TypesReads only

List event types with usage statistics. Organization Access Token permissions: `events:read` or `events:write`.

List EventsReads only

List events. Organization Access Token permissions: `events:read` or `events:write`.

List FilesReads only

List files. Organization Access Token permissions: `files:read` or `files:write`.

List License KeysReads only

Get license keys connected to the given organization & filters. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `license_keys:read` or `license_keys:write`.

List MetersReads only

List meters. Organization Access Token permissions: `meters:read` or `meters:write`.

List Metric DashboardsReads only

List user-defined metric dashboards. Organization Access Token permissions: `metrics:read`.

List OrdersReads only

List orders. Organization Access Token permissions: `orders:read`.

List OrganizationsReads only

List organizations. Organization Access Token permissions: `organizations:read` or `organizations:write`.

List PaymentsReads only

List payments. Organization Access Token permissions: `payments:read`.

List ProductsReads only

List products. Organization Access Token permissions: `products:read` or `products:write`.

List RefundsReads only

List refunds. Organization Access Token permissions: `refunds:read` or `refunds:write`.

List SeatsReads only

List customer seats for a subscription or order, including invitation and claim state.

List SubscriptionsReads only

List subscriptions. Organization Access Token permissions: `subscriptions:read` or `subscriptions:write`.

List Webhook DeliveriesReads only

List webhook deliveries. Organization Access Token permissions: `webhooks:read` or `webhooks:write`.

List Webhook EndpointsReads only

List webhook endpoints with pagination; Organization Access Token permissions are `webhooks:read` or `webhooks:write`. The response contains sensitive webhook signing secrets; never log or persist it.

Redeliver Webhook Event

Schedule the re-delivery of a webhook event. This triggers a new external webhook delivery attempt. This causes an external delivery attempt and must not be retried automatically. Organization Access Token permissions: `webhooks:write`.

Resend Invitation

Resend the invitation email for an unclaimed customer seat. This triggers an external email delivery and should not be retried automatically.

Revoke Seat

Permanently revoke a customer seat by ID. Verify the seat before removing access.

Revoke Subscription

Revoke a subscription, i.e cancel immediately. This irreversibly revokes the subscription immediately. Organization Access Token permissions: `subscriptions:write`.

Rotate License Key

Rotate a license key. The request or response contains sensitive credential material; never log or persist it. This irreversibly replaces the existing secret; update dependents immediately. Organization Access Token permissions: `license_keys:write`.

Update Benefit

Update a benefit. Organization Access Token permissions: `benefits:write`.

Update Checkout Link

Update a checkout link. Organization Access Token permissions: `checkout_links:write`.

Update Checkout Session

Update a checkout session. Organization Access Token permissions: `checkouts:write`.

Update Checkout Session from Client

Update a checkout session by client secret.

Update Custom Field

Update an organization custom field's label, validation, or data-collection settings.

Update Customer

Update a customer. Organization Access Token permissions: `customers:write`.

Update Customer by External ID

Update a customer by external ID. Organization Access Token permissions: `customers:write`.

Update Customer Member

Update a member by customer UUID and member UUID. Role changes can grant billing or ownership privileges, so verify the target and role first. Organization Access Token permissions: `members:write`.

Update Customer Member by External ID

Update a member by customer and member external IDs. Role changes can grant billing or ownership privileges, so verify both targets and the role first. Organization Access Token permissions: `members:write`.

Update Discount

Update a discount. Organization Access Token permissions: `discounts:write`.

Update Event Type

Update an event type's label and optionally its dynamic label selector. Organization Access Token permissions: `events:write`.

Update File

Update a file's name or version. Organization Access Token permissions: `files:write`.

Update License Key

Update a license key. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `license_keys:write`.

Update Meter

Update a meter. Organization Access Token permissions: `meters:write`.

Update Metric Dashboard

Update a user-defined metric dashboard. Organization Access Token permissions: `metrics:write`.

Update Order

Update an order's billing name or billing address; country and state cannot be updated. Organization Access Token permissions: `orders:write`.

Update Organization

Update an organization. Organization Access Token permissions: `organizations:write`.

Update Product

Update a product. Organization Access Token permissions: `products:write`.

Update Product Benefits

Update benefits granted by a product. Organization Access Token permissions: `products:write`.

Update Subscription

Update a subscription. Organization Access Token permissions: `subscriptions:write`.

Update Webhook Endpoint

Update a webhook endpoint. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `webhooks:write`.

Validate License Key

Validate a license key and optionally increment its usage count. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: `license_keys:write`.

Validate License Key

Validate a license key and optionally increment its usage count.

More in Payment processing

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or