Polar
Polar is a merchant-of-record platform for products, checkouts, customers, subscriptions, orders, benefits, and metrics.
181 actionsSign in with Polar
What your bot can do in Polar
Looks up
- Check Email Change TokenCheck if an email change verification token is still valid.
- Export CustomersExport customers as a CSV file.
- Export MetricsExport metrics as a CSV file.
- Export OrdersExport orders as a CSV file.
- Export SubscriptionsExport subscriptions as a CSV file.
- Get ActivationGet a license key activation.
- Get Authenticated Portal UserGet information about the currently authenticated portal user.
- Get BenefitGet a benefit by ID.
- Get Benefit GrantGet a benefit grant by ID for the authenticated customer.
- Get Checkout LinkGet a checkout link by ID.
Show 81 more
- Get Checkout SessionGet a checkout session by ID.
- Get Checkout Session from ClientGet a checkout session by client secret.
- Get Claim InfoInspect a one-time customer-seat invitation before claiming it, including the customer and subscription context.
- Get Custom FieldGet one organization custom field and its validation settings by ID.
- Get CustomerGet a customer by ID.
- Get CustomerGet authenticated customer.
- Get Customer by External IDGet a customer by external ID.
- Get Customer MemberGet a member by customer UUID and member UUID without changing membership.
- Get Customer Member by External IDGet a member by customer and member external IDs without changing membership.
- Get Customer MeterGet a customer meter by ID.
- Get Customer MeterGet a meter by ID for the authenticated customer.
- Get Customer StateGet a customer state by ID.
- Get Customer State by External IDGet a customer state by external ID.
- Get DiscountGet a discount by ID.
- Get DisputeGet a payment dispute by ID.
- Get EventGet an event by ID.
- Get License KeyGet a license key.
- Get License KeyGet a license key.
- Get MeterGet a meter by ID.
- Get Meter QuantitiesGet quantities of a meter over a time period.
- Get Metric DashboardGet a user-defined metric dashboard by ID.
- Get MetricsGet metrics about your orders and subscriptions.
- Get Metrics LimitsGet the interval limits for the metrics endpoint.
- Get OrderGet an order by ID.
- Get OrderGet an order by ID for the authenticated customer.
- Get Order InvoiceGet an order's invoice data.
- Get Order InvoiceGet an order's invoice data.
- Get Order Payment StatusGet the current payment status for an order.
- Get Order ReceiptGet a presigned URL to download an order's receipt PDF.
- Get Order ReceiptGet a presigned URL to download an order's receipt PDF.
- Get OrganizationGet an organization by ID.
- Get OrganizationGet a customer portal's organization by slug.
- Get PaymentGet a payment by ID.
- Get Portal WalletGet a wallet by ID using an authenticated customer or member session.
- Get ProductGet a product by ID.
- Get SubscriptionGet a subscription for the authenticated customer.
- Get SubscriptionGet a subscription by ID.
- Get Webhook EndpointGet a webhook endpoint by ID.
- Introspect Customer SessionIntrospect the current session and return its information.
- List Benefit FilesList the downloadable files for a benefit with their download statistics.
- List Benefit GrantsList benefit grants across all benefits accessible to the authenticated subject.
- List Benefit GrantsList the individual grants for a benefit.
- List Benefit GrantsList benefits grants of the authenticated customer.
- List BenefitsList benefits.
- List Checkout LinksList checkout links.
- List Checkout SessionsList checkout sessions.
- List Custom FieldsList custom data fields configured for an organization and their validation settings.
- List Customer MembersList members of a customer by UUID without changing membership.
- List Customer Members by External IDList members of a uniquely identified external customer without changing membership.
- List Customer MetersList customer meters.
- List Customer Payment MethodsGet saved payment methods of a customer.
- List Customer Payment MethodsGet saved payment methods of the authenticated customer.
- List Customer Payment Methods by External IDGet saved payment methods of a customer by external ID.
- List CustomersList customers.
- List DiscountsList discounts.
- List DisputesList payment disputes.
- List DownloadablesList files the authenticated customer can download through granted benefits, optionally filtered by benefit.
- List Event NamesList event names.
- List Event TypesList event types with usage statistics.
- List EventsList events.
- List FilesList files.
- List License KeysGet license keys connected to the given organization & filters.
- List License KeysList license keys issued to the authenticated customer, with optional organization and benefit filters.
- List MetersList meters.
- List MetersList meters of the authenticated customer.
- List Metric DashboardsList user-defined metric dashboards.
- List OrdersList orders.
- List OrdersList orders of the authenticated customer.
- List OrganizationsList organizations.
- List PaymentsList payments.
- List Portal Claimed SubscriptionsList subscriptions claimed through seats by the authenticated customer or member session.
- List Portal MembersList customer portal members.
- List Portal SeatsList seats for a subscription or order available to the authenticated customer or member session.
- List Portal WalletsList wallets available to the authenticated customer or member session.
- List ProductsList products.
- List RefundsList refunds.
- List SeatsList seats assigned from organization subscriptions, including invitation and claim state.
- List SubscriptionsList subscriptions of the authenticated customer.
- List SubscriptionsList subscriptions.
- List Webhook DeliveriesList webhook deliveries.
- List Webhook EndpointsList webhook endpoints.
Takes action
- Accept DisputeAccept a dispute, permanently conceding the chargeback and settling it as lost.
- Activate License KeyActivate a license key instance.
- Activate License KeyActivate a license key instance.
- Add Customer Payment MethodAdd a payment method to the authenticated customer.
- Add Portal MemberAdd a customer portal member.
- Assign Portal SeatAssign a seat using an authenticated customer or member session.
- Assign SeatAssign a customer seat.
- Cancel SubscriptionCancel a subscription of the authenticated customer.
- Claim SeatClaim a customer seat without authentication using a one-time invitation token.
- Complete File UploadComplete a file upload.
Show 80 more
- Confirm Checkout Session from ClientConfirm a checkout session by client secret.
- Confirm Customer Payment MethodConfirm a payment method for the authenticated customer.
- Confirm Retry PaymentConfirm a retry payment using a Stripe confirmation token.
- Create BenefitCreate a benefit, for example license keys, file downloads or Discord access.
- Create Checkout LinkCreate a checkout link.
- Create Checkout SessionCreate a checkout session.
- Create Custom FieldCreate an organization custom field for collecting structured customer or checkout data.
- Create CustomerCreate a customer.
- Create Customer MemberAdd a member to a customer by UUID.
- Create Customer Member by External IDAdd a member to a uniquely identified external customer.
- Create Customer SessionCreate a customer session.
- Create DiscountCreate a discount.
- Create FileCreate a file.
- Create MeterCreate a meter.
- Create Metric DashboardCreate a user-defined metric dashboard.
- Create OrderCreate a draft order for an off-session charge against a saved payment Organization Access Token permissions.
- Create OrganizationCreate an organization.
- Create ProductCreate a product.
- Create RefundCreate a refund.
- Create SubscriptionCreate a subscription programmatically.
- Create Webhook EndpointCreate a webhook endpoint.
- Deactivate License KeyDeactivate a license key instance.
- Deactivate License KeyDeactivate a license key instance.
- Delete BenefitDelete a benefit.
- Delete Checkout LinkDelete a checkout link.
- Delete Custom FieldPermanently delete a custom field by ID.
- Delete CustomerDelete a customer.
- Delete Customer by External IDDelete a customer by external ID.
- Delete Customer MemberPermanently remove a member by customer UUID and member UUID.
- Delete Customer Member by External IDPermanently remove a member by customer and member external IDs.
- Delete Customer Payment MethodDelete a payment method from the authenticated customer.
- Delete DiscountDelete a discount.
- Delete FileDelete a file.
- Delete Metric DashboardDelete a user-defined metric dashboard.
- Delete ProductDelete a product.
- Delete Webhook EndpointDelete a webhook endpoint.
- Finalize OrderFinalize a draft order and synchronously attempt an off-session charge.
- Generate Order InvoiceTrigger generation of an order's invoice.
- Generate Order InvoiceTrigger generation of an order's invoice.
- Ingest EventsIngest batch of events.
- Redeliver Webhook EventSchedule the re-delivery of a webhook event.
- Remove Portal MemberPermanently remove a customer portal member.
- Request Email ChangeRequest an email change for the authenticated customer.
- Resend InvitationResend the invitation email for an unclaimed customer seat.
- Resend Portal Seat InvitationResend a pending seat invitation using an authenticated customer or member session.
- Reset Webhook Endpoint SecretRegenerate a webhook endpoint secret.
- Revoke Portal SeatPermanently revoke a seat using an authenticated customer or member session.
- Revoke SeatPermanently revoke a customer seat by ID.
- Revoke SubscriptionRevoke a subscription, i.e cancel immediately.
- Rotate License KeyRotate a license key.
- Rotate License KeyRotate a license key.
- Update BenefitUpdate a benefit.
- Update Benefit GrantUpdate a benefit grant for the authenticated customer.
- Update Checkout LinkUpdate a checkout link.
- Update Checkout SessionUpdate a checkout session.
- Update Checkout Session from ClientUpdate a checkout session by client secret.
- Update Custom FieldUpdate an organization custom field's label, validation, or data-collection settings.
- Update CustomerUpdate a customer.
- Update CustomerUpdate authenticated customer.
- Update Customer by External IDUpdate a customer by external ID.
- Update Customer MemberUpdate a member by customer UUID and member UUID.
- Update Customer Member by External IDUpdate a member by customer and member external IDs.
- Update DiscountUpdate a discount.
- Update Event TypeUpdate an event type's label or dynamic label selector.
- Update FileUpdate a file.
- Update License KeyUpdate a license key.
- Update MeterUpdate a meter.
- Update Metric DashboardUpdate a user-defined metric dashboard.
- Update OrderUpdate an order.
- Update OrderUpdate an order for the authenticated customer.
- Update OrganizationUpdate an organization.
- Update Portal MemberUpdate a customer portal member's name or role.
- Update ProductUpdate a product.
- Update Product BenefitsUpdate benefits granted by a product.
- Update SubscriptionUpdate a subscription of the authenticated customer.
- Update SubscriptionUpdate a subscription.
- Update Webhook EndpointUpdate a webhook endpoint.
- Validate License KeyValidate a license key and optionally increment its usage count.
- Validate License KeyValidate a license key and optionally increment its usage count.
- Verify Email ChangeVerify and apply an email change using the token from the verification email.