Polar integration (Finance, Developer Tools). Imported from open-connector.
https://api.polar.sh/v1/organizations/
| Param | Type | Required | Description |
|---|---|---|---|
| slug | string | optional | Filter organizations by slug. |
| page | integer | optional | Page number, starting from 1. |
| limit | integer | optional | Number of items to return per page. Polar supports up to 100. |
| sorting | array | optional | Polar organization sorting fields. |
//organizations/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The Polar resource ID. |
/products/
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter by product ID. |
| organization_id | string | optional | Filter by organization ID. |
| query | string | optional | Filter by product name. |
| is_archived | boolean | optional | Filter by archived products. |
| is_recurring | boolean | optional | Filter by recurring products. |
| benefit_id | string | optional | Filter products granting a benefit. |
| visibility | array | optional | Product visibility values to include. |
| page | integer | optional | Page number, starting from 1. |
| limit | integer | optional | Number of items to return per page. Polar supports up to 100. |
| sorting | array | optional | Polar product sorting fields. |
| metadata | object | optional | Metadata filters sent with Polar's deepObject query style. |
//products/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The Polar resource ID. |
/customers/
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | optional | Filter by organization ID. |
| string | optional | Filter by exact customer email. | |
| query | string | optional | Filter by customer name, email, or external ID. |
| active | boolean | optional | Filter by active customers. |
| page | integer | optional | Page number, starting from 1. |
| limit | integer | optional | Number of items to return per page. Polar supports up to 100. |
| sorting | array | optional | Polar customer sorting fields. |
| metadata | object | optional | Metadata filters sent with Polar's deepObject query style. |
//customers/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The Polar resource ID. |
//customers/external/{external_id}
| Param | Type | Required | Description |
|---|---|---|---|
| external_id | string | required | The Polar customer external ID. |
//customers/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The Polar resource ID. |
//customers/external/{external_id}
| Param | Type | Required | Description |
|---|---|---|---|
| external_id | string | required | The Polar customer external ID. |
/orders/
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | optional | Filter by organization ID. |
| product_id | string | optional | Filter by product ID. |
| product_billing_type | string | optional | Filter by product billing type. |
| discount_id | string | optional | Filter by discount ID. |
| customer_id | string | optional | Filter by customer ID. |
| external_customer_id | string | optional | Filter by customer external ID. |
| checkout_id | string | optional | Filter by checkout ID. |
| subscription_id | string | optional | Filter by subscription ID. |
| page | integer | optional | Page number, starting from 1. |
| limit | integer | optional | Number of items to return per page. Polar supports up to 100. |
| sorting | array | optional | Polar order sorting fields. |
| metadata | object | optional | Metadata filters sent with Polar's deepObject query style. |
//orders/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The Polar resource ID. |
/subscriptions/
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | optional | Filter by organization ID. |
| product_id | string | optional | Filter by product ID. |
| customer_id | string | optional | Filter by customer ID. |
| external_customer_id | string | optional | Filter by customer external ID. |
| discount_id | string | optional | Filter by discount ID. |
| active | boolean | optional | Filter by active or inactive subscription. This Polar filter is deprecated upst… |
| status | string | optional | Filter by subscription status. |
| cancel_at_period_end | boolean | optional | Filter by subscriptions set to cancel at period end. |
| customer_cancellation_reason | string | optional | Filter by customer cancellation reason. |
| canceled_at_after | string | optional | Filter by cancellation timestamp after or equal to this value. |
| canceled_at_before | string | optional | Filter by cancellation timestamp before or equal to this value. |
| page | integer | optional | Page number, starting from 1. |
| limit | integer | optional | Number of items to return per page. Polar supports up to 100. |
| sorting | array | optional | Polar subscription sorting fields. |
| metadata | object | optional | Metadata filters sent with Polar's deepObject query style. |
//subscriptions/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The Polar resource ID. |