← Tools Reference

Polar

Polar integration (Finance, Developer Tools). Imported from open-connector.

API key13 toolshttps://api.polar.sh/v1
GET
polar_list_organizations
List Polar organizations accessible to the Organization Access Token.

/organizations/

4 parameters
ParamTypeRequiredDescription
slugstringoptionalFilter organizations by slug.
pageintegeroptionalPage number, starting from 1.
limitintegeroptionalNumber of items to return per page. Polar supports up to 100.
sortingarrayoptionalPolar organization sorting fields.
GET
polar_get_organization
Get a Polar organization by ID.

//organizations/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Polar resource ID.
GET
polar_list_products
List Polar products with optional organization, name, visibility, and metadata filters.

/products/

11 parameters
ParamTypeRequiredDescription
idstringoptionalFilter by product ID.
organization_idstringoptionalFilter by organization ID.
querystringoptionalFilter by product name.
is_archivedbooleanoptionalFilter by archived products.
is_recurringbooleanoptionalFilter by recurring products.
benefit_idstringoptionalFilter products granting a benefit.
visibilityarrayoptionalProduct visibility values to include.
pageintegeroptionalPage number, starting from 1.
limitintegeroptionalNumber of items to return per page. Polar supports up to 100.
sortingarrayoptionalPolar product sorting fields.
metadataobjectoptionalMetadata filters sent with Polar's deepObject query style.
GET
polar_get_product
Get a Polar product by ID.

//products/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Polar resource ID.
GET
polar_list_customers
List Polar customers with optional organization, email, search, activity, and metadata filters.

/customers/

8 parameters
ParamTypeRequiredDescription
organization_idstringoptionalFilter by organization ID.
emailstringoptionalFilter by exact customer email.
querystringoptionalFilter by customer name, email, or external ID.
activebooleanoptionalFilter by active customers.
pageintegeroptionalPage number, starting from 1.
limitintegeroptionalNumber of items to return per page. Polar supports up to 100.
sortingarrayoptionalPolar customer sorting fields.
metadataobjectoptionalMetadata filters sent with Polar's deepObject query style.
GET
polar_get_customer
Get a Polar customer by ID.

//customers/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Polar resource ID.
GET
polar_get_customer_by_external_id
Get a Polar customer by external ID.

//customers/external/{external_id}

1 parameter
ParamTypeRequiredDescription
external_idstringrequiredThe Polar customer external ID.
GET
polar_get_customer_state
Get a Polar customer state by customer ID, including subscriptions and benefits.

//customers/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Polar resource ID.
GET
polar_get_customer_state_by_external_id
Get a Polar customer state by external customer ID, including subscriptions and benefits.

//customers/external/{external_id}

1 parameter
ParamTypeRequiredDescription
external_idstringrequiredThe Polar customer external ID.
GET
polar_list_orders
List Polar orders with optional organization, product, customer, checkout, subscription, and metadata filters.

/orders/

12 parameters
ParamTypeRequiredDescription
organization_idstringoptionalFilter by organization ID.
product_idstringoptionalFilter by product ID.
product_billing_typestringoptionalFilter by product billing type.
discount_idstringoptionalFilter by discount ID.
customer_idstringoptionalFilter by customer ID.
external_customer_idstringoptionalFilter by customer external ID.
checkout_idstringoptionalFilter by checkout ID.
subscription_idstringoptionalFilter by subscription ID.
pageintegeroptionalPage number, starting from 1.
limitintegeroptionalNumber of items to return per page. Polar supports up to 100.
sortingarrayoptionalPolar order sorting fields.
metadataobjectoptionalMetadata filters sent with Polar's deepObject query style.
GET
polar_get_order
Get a Polar order by ID.

//orders/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Polar resource ID.
GET
polar_list_subscriptions
List Polar subscriptions with optional organization, product, customer, status, cancellation, and metadata filters.

/subscriptions/

15 parameters
ParamTypeRequiredDescription
organization_idstringoptionalFilter by organization ID.
product_idstringoptionalFilter by product ID.
customer_idstringoptionalFilter by customer ID.
external_customer_idstringoptionalFilter by customer external ID.
discount_idstringoptionalFilter by discount ID.
activebooleanoptionalFilter by active or inactive subscription. This Polar filter is deprecated upst…
statusstringoptionalFilter by subscription status.
cancel_at_period_endbooleanoptionalFilter by subscriptions set to cancel at period end.
customer_cancellation_reasonstringoptionalFilter by customer cancellation reason.
canceled_at_afterstringoptionalFilter by cancellation timestamp after or equal to this value.
canceled_at_beforestringoptionalFilter by cancellation timestamp before or equal to this value.
pageintegeroptionalPage number, starting from 1.
limitintegeroptionalNumber of items to return per page. Polar supports up to 100.
sortingarrayoptionalPolar subscription sorting fields.
metadataobjectoptionalMetadata filters sent with Polar's deepObject query style.
GET
polar_get_subscription
Get a Polar subscription by ID.

//subscriptions/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Polar resource ID.