> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Polar

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

![Polar logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/polar.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=81f54b63191c09d149c856d3211bc97b)

* **Category:** payment processing
* **Auth:** OAUTH2, API\_KEY
* **Composio-managed OAuth available?** No
* **Tools:** 134
* **Triggers:** 0
* **Slug:** `POLAR`
* **Version:** 20261101\_00

## Tools

> [accordion] Accept Dispute
>
> **Slug:** `POLAR_ACCEPT_DISPUTE`
>
> Accept a dispute, permanently conceding the chargeback and settling it as lost. Organization Access Token permissions: `disputes:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The dispute ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Activate License Key
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **key** `string` *required*
>
> Sensitive license key value.
>
> **meta** `object`
>
> Key-value object allowing you to store additional information about the activation  The key must be a string with a maximum length of **40 characters**. The value must be either:  \* A string with a maximum length of **500 characters** \* An integer \* A floating-point number \* A boolean  You can store up to **50 key-value pairs**.
>
> **label** `string` *required*
>
> Human-readable activation label.
>
> **conditions** `object`
>
> Key-value object allowing you to set conditions that must match when validating the license key.  The key must be a string with a maximum length of **40 characters**. The value must be either:  \* A string with a maximum length of **500 characters** \* An integer \* A floating-point number \* A boolean  You can store up to **50 key-value pairs**.
>
> **organization\_id** `string` *required*
>
> Polar organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Activate License Key
>
> **Slug:** `POLAR_ACTIVATE_LICENSE_KEY_PUBLIC`
>
> Activate a license key instance. This consumes an activation slot until the instance is deactivated.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar LicenseKeyActivate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Seat
>
> **Slug:** `POLAR_ASSIGN_CUSTOMER_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.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar SeatAssign schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Complete File Upload
>
> **Slug:** `POLAR_COMPLETE_FILE_UPLOAD`
>
> Complete a file upload. Organization Access Token permissions: `files:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The file ID.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar FileUploadCompleted schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Confirm Checkout Session from Client
>
> **Slug:** `POLAR_CONFIRM_CHECKOUT_BY_CLIENT_SECRET`
>
> Confirm a checkout session by client secret. This may trigger payment or finalize an existing transaction.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar CheckoutConfirmStripe schema.
>
> **client\_secret** `string` *required*
>
> The checkout session client secret.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Benefit
>
> **Slug:** `POLAR_CREATE_BENEFIT`
>
> Create a benefit, for example license keys, file downloads or Discord access. Organization Access Token permissions: `benefits:write`.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Request payload matching the exact Polar BenefitCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Checkout Session
>
> **Slug:** `POLAR_CREATE_CHECKOUT`
>
> Create a checkout session. Organization Access Token permissions: `checkouts:write`.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar CheckoutCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Checkout Link
>
> **Slug:** `POLAR_CREATE_CHECKOUT_LINK`
>
> Create a checkout link. Organization Access Token permissions: `checkout_links:write`.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Request payload matching the exact Polar CheckoutLinkCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Customer
>
> **Slug:** `POLAR_CREATE_CUSTOMER`
>
> Create a customer. Organization Access Token permissions: `customers:write`.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Request payload matching the exact Polar CustomerCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Customer Member
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> **body** `object` *required*
>
> The member to add to the customer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Customer Member by External ID
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> The member to add to the customer.
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Field
>
> **Slug:** `POLAR_CREATE_CUSTOM_FIELD`
>
> Create an organization custom field for collecting structured customer or checkout data.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Request payload matching the exact Polar CustomFieldCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Discount
>
> **Slug:** `POLAR_CREATE_DISCOUNT`
>
> Create a discount. Organization Access Token permissions: `discounts:write`.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Request payload matching the exact Polar DiscountCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create File
>
> **Slug:** `POLAR_CREATE_FILE`
>
> Create a Polar file record and obtain multipart upload details. Organization Access Token permissions: `files:write`.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Request payload matching the exact Polar FileCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Meter
>
> **Slug:** `POLAR_CREATE_METER`
>
> Create a meter. Organization Access Token permissions: `meters:write`.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar MeterCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Metric Dashboard
>
> **Slug:** `POLAR_CREATE_METRIC_DASHBOARD`
>
> Create a user-defined metric dashboard. Organization Access Token permissions: `metrics:write`.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar MetricDashboardCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Order
>
> **Slug:** `POLAR_CREATE_ORDER`
>
> Create a draft order for an off-session charge against a saved payment Organization Access Token permissions: `orders:write`.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar OrderCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Organization
>
> **Slug:** `POLAR_CREATE_ORGANIZATION`
>
> Create an organization using OAuth2 with the organizations:write scope.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar OrganizationCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Product
>
> **Slug:** `POLAR_CREATE_PRODUCT`
>
> Create a product. Organization Access Token permissions: `products:write`.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Request payload matching the exact Polar ProductCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Refund
>
> **Slug:** `POLAR_CREATE_REFUND`
>
> Create a refund. Organization Access Token permissions: `refunds:write`.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar RefundCreate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Subscription
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Request payload matching the exact Polar Subscription Create schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Webhook Endpoint
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The URL where the webhook events will be sent.
>
> **name** `string`
>
> An optional name for the webhook endpoint to help organize and identify it.
>
> **events** `array` *required*
>
> The events that will trigger the webhook.
>
> **format** `string ("raw" | "discord" | "slack")` *required*
>
> The format of the webhook payload.
>
> **api\_version** `string ("2026-04" | "2026-10")`
>
> The API version that'll be used in event payloads.
>
> **organization\_id** `string`
>
> The organization ID associated with the webhook endpoint. **Required unless you use an organization token.**
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Deactivate License Key
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **key** `string` *required*
>
> Sensitive license key value.
>
> **activation\_id** `string` *required*
>
> License key activation ID.
>
> **organization\_id** `string` *required*
>
> Polar organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Deactivate License Key
>
> **Slug:** `POLAR_DEACTIVATE_LICENSE_KEY_PUBLIC`
>
> Deactivate a license key instance. The identified installation immediately loses its activation.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar LicenseKeyDeactivate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Benefit
>
> **Slug:** `POLAR_DELETE_BENEFIT`
>
> Delete a benefit. This also revokes every associated grant and removes user access. Organization Access Token permissions: `benefits:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Checkout Link
>
> **Slug:** `POLAR_DELETE_CHECKOUT_LINK`
>
> Delete a checkout link. Organization Access Token permissions: `checkout_links:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The checkout link ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Customer
>
> **Slug:** `POLAR_DELETE_CUSTOMER`
>
> Delete a customer. Organization Access Token permissions: `customers:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> **anonymize** `boolean`
>
> If true, also anonymize the customer's personal data for GDPR compliance. This replaces email with a hashed version, hashes name and billing name (name preserved for businesses with tax\_id), clears billing address, and removes OAuth account data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Customer by External ID
>
> **Slug:** `POLAR_DELETE_CUSTOMER_BY_EXTERNAL_ID`
>
> Delete a customer by external ID. Organization Access Token permissions: `customers:write`.
>
> #### Input Parameters
>
> **anonymize** `boolean`
>
> If true, also anonymize the customer's personal data for GDPR compliance.
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Customer Member
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> **member\_id** `string` *required*
>
> The member ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Customer Member by External ID
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> **member\_external\_id** `string` *required*
>
> The member external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Custom Field
>
> **Slug:** `POLAR_DELETE_CUSTOM_FIELD`
>
> Permanently delete a custom field by ID. Verify the field before deletion.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The custom field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Discount
>
> **Slug:** `POLAR_DELETE_DISCOUNT`
>
> Delete a discount. Organization Access Token permissions: `discounts:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The discount ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete File
>
> **Slug:** `POLAR_DELETE_FILE`
>
> Delete a file. Organization Access Token permissions: `files:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Metric Dashboard
>
> **Slug:** `POLAR_DELETE_METRIC_DASHBOARD`
>
> Delete a user-defined metric dashboard. Organization Access Token permissions: `metrics:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The metric dashboard ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Product
>
> **Slug:** `POLAR_DELETE_PRODUCT`
>
> Delete a product. Organization Access Token permissions: `products:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook Endpoint
>
> **Slug:** `POLAR_DELETE_WEBHOOK_ENDPOINT`
>
> Delete a webhook endpoint. Organization Access Token permissions: `webhooks:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The webhook endpoint ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export Customers
>
> **Slug:** `POLAR_EXPORT_CUSTOMERS`
>
> Export customers as a CSV file. Organization Access Token permissions: `customers:read` or `customers:write`.
>
> #### Input Parameters
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export Metrics
>
> **Slug:** `POLAR_EXPORT_METRICS`
>
> Export metrics as a CSV file. Organization Access Token permissions: `metrics:read`.
>
> #### Input Parameters
>
> **metrics** `array`
>
> List of metric slugs to include in the export. If not provided, all metrics are exported.
>
> **end\_date** `string` *required*
>
> End date.
>
> **interval** `string ("year" | "month" | "week" | "day" | "hour")` *required*
>
> Interval between two timestamps.
>
> **timezone** `string ("Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Timbuktu" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/ComodRivadavia" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Atka" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Coyhaique" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Ensenada" | "America/Fort_Nelson" | "America/Fort_Wayne" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Knox_IN" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montreal" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Acre" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Rosario" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Shiprock" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Virgin" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/South_Pole" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Ashkhabad" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Chungking" | "Asia/Colombo" | "Asia/Dacca" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Harbin" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Istanbul" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kashgar" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macao" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tel_Aviv" | "Asia/Thimbu" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ujung_Pandang" | "Asia/Ulaanbaatar" | "Asia/Ulan_Bator" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Jan_Mayen" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/ACT" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/LHI" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/NSW" | "Australia/North" | "Australia/Perth" | "Australia/Queensland" | "Australia/South" | "Australia/Sydney" | "Australia/Tasmania" | "Australia/Victoria" | "Australia/West" | "Australia/Yancowinna" | "Brazil/Acre" | "Brazil/DeNoronha" | "Brazil/East" | "Brazil/West" | "CET" | "CST6CDT" | "Canada/Atlantic" | "Canada/Central" | "Canada/Eastern" | "Canada/Mountain" | "Canada/Newfoundland" | "Canada/Pacific" | "Canada/Saskatchewan" | "Canada/Yukon" | "Chile/Continental" | "Chile/EasterIsland" | "Cuba" | "EET" | "EST" | "EST5EDT" | "Egypt" | "Eire" | "Etc/GMT" | "Etc/GMT+0" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-0" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/GMT0" | "Etc/Greenwich" | "Etc/UCT" | "Etc/UTC" | "Etc/Universal" | "Etc/Zulu" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belfast" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Nicosia" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Tiraspol" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Factory" | "GB" | "GB-Eire" | "GMT" | "GMT+0" | "GMT-0" | "GMT0" | "Greenwich" | "HST" | "Hongkong" | "Iceland" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Iran" | "Israel" | "Jamaica" | "Japan" | "Kwajalein" | "Libya" | "MET" | "MST" | "MST7MDT" | "Mexico/BajaNorte" | "Mexico/BajaSur" | "Mexico/General" | "NZ" | "NZ-CHAT" | "Navajo" | "PRC" | "PST8PDT" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Samoa" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Yap" | "Poland" | "Portugal" | "ROC" | "ROK" | "Singapore" | "Turkey" | "UCT" | "US/Alaska" | "US/Aleutian" | "US/Arizona" | "US/Central" | "US/East-Indiana" | "US/Eastern" | "US/Hawaii" | "US/Indiana-Starke" | "US/Michigan" | "US/Mountain" | "US/Pacific" | "US/Samoa" | "UTC" | "Universal" | "W-SU" | "WET" | "Zulu")`
>
> Timezone to use for the timestamps. Default is UTC.
>
> **product\_id** `string`
>
> Filter by product ID.
>
> **start\_date** `string` *required*
>
> Start date.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **billing\_type** `string`
>
> Filter by billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export Orders
>
> **Slug:** `POLAR_EXPORT_ORDERS`
>
> Export orders as a CSV file. Organization Access Token permissions: `orders:read`.
>
> #### Input Parameters
>
> **status** `string`
>
> Filter by order status.
>
> **columns** `string`
>
> Columns to include in the CSV, in order. Defaults to email, created\_at, product, net\_amount, currency, status and invoice\_number.
>
> **timezone** `string`
>
> Time zone used to render dates in the CSV.
>
> **product\_id** `string`
>
> Filter by product ID.
>
> **created\_after** `string`
>
> Only include orders created after this date. Must include a UTC offset.
>
> **created\_before** `string`
>
> Only include orders created before this date. Must include a UTC offset.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export Subscriptions
>
> **Slug:** `POLAR_EXPORT_SUBSCRIPTIONS`
>
> Export subscriptions as a CSV file. Organization Access Token permissions: `subscriptions:read` or `subscriptions:write`.
>
> #### Input Parameters
>
> **status** `string`
>
> Filter by subscription status.
>
> **columns** `string`
>
> Columns to include in the CSV, in order. Defaults to email, started\_at, product, amount, currency, status and recurring\_interval.
>
> **timezone** `string`
>
> Time zone used to render dates in the CSV.
>
> **product\_id** `string`
>
> Filter by product ID.
>
> **started\_after** `string`
>
> Only include subscriptions started after this date. Must include a UTC offset.
>
> **started\_before** `string`
>
> Only include subscriptions started before this date. Must include a UTC offset.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **cancel\_at\_period\_end** `boolean`
>
> Filter by subscriptions that are set to cancel at period end.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Finalize Order
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The order ID.
>
> **body** `object`
>
> Schema to finalize a draft order and trigger an off-session charge.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Order Invoice
>
> **Slug:** `POLAR_GENERATE_ORDER_INVOICE`
>
> Trigger generation of an order's invoice. Organization Access Token permissions: `orders:read`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The order ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Benefit
>
> **Slug:** `POLAR_GET_BENEFIT`
>
> Get a benefit by ID. Organization Access Token permissions: `benefits:read` or `benefits:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Checkout Session
>
> **Slug:** `POLAR_GET_CHECKOUT`
>
> Get a checkout session by ID. Organization Access Token permissions: `checkouts:read` or `checkouts:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The checkout session ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Checkout Session from Client
>
> **Slug:** `POLAR_GET_CHECKOUT_BY_CLIENT_SECRET`
>
> Get a checkout session by client secret.
>
> #### Input Parameters
>
> **client\_secret** `string` *required*
>
> The checkout session client secret.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Checkout Link
>
> **Slug:** `POLAR_GET_CHECKOUT_LINK`
>
> Get a checkout link by ID. Organization Access Token permissions: `checkout_links:read` or `checkout_links:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The checkout link ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer
>
> **Slug:** `POLAR_GET_CUSTOMER`
>
> Get a customer by ID. Organization Access Token permissions: `customers:read` or `customers:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer by External ID
>
> **Slug:** `POLAR_GET_CUSTOMER_BY_EXTERNAL_ID`
>
> Get a customer by external ID. Organization Access Token permissions: `customers:read` or `customers:write`.
>
> #### Input Parameters
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer Member
>
> **Slug:** `POLAR_GET_CUSTOMER_MEMBER`
>
> Get a member by customer UUID and member UUID without changing membership. Organization Access Token permissions: `members:read` or `members:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> **member\_id** `string` *required*
>
> The member ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer Member by External ID
>
> **Slug:** `POLAR_GET_CUSTOMER_MEMBER_BY_EXTERNAL_ID`
>
> 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`.
>
> #### Input Parameters
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> **member\_external\_id** `string` *required*
>
> The member external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer Meter
>
> **Slug:** `POLAR_GET_CUSTOMER_METER`
>
> Get a customer meter by ID. Organization Access Token permissions: `customer_meters:read`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer meter ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer State
>
> **Slug:** `POLAR_GET_CUSTOMER_STATE`
>
> Get a customer state by ID. Organization Access Token permissions: `customers:read` or `customers:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer State by External ID
>
> **Slug:** `POLAR_GET_CUSTOMER_STATE_BY_EXTERNAL_ID`
>
> Get a customer state by external ID. Organization Access Token permissions: `customers:read` or `customers:write`.
>
> #### Input Parameters
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Field
>
> **Slug:** `POLAR_GET_CUSTOM_FIELD`
>
> Get one organization custom field and its validation settings by ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The custom field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Discount
>
> **Slug:** `POLAR_GET_DISCOUNT`
>
> Get a discount by ID. Organization Access Token permissions: `discounts:read` or `discounts:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The discount ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Dispute
>
> **Slug:** `POLAR_GET_DISPUTE`
>
> Get a payment dispute by ID. Organization Access Token permissions: `disputes:read` or `disputes:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The dispute ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Event
>
> **Slug:** `POLAR_GET_EVENT`
>
> Get an event by ID. Organization Access Token permissions: `events:read` or `events:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The event ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get License Key
>
> **Slug:** `POLAR_GET_LICENSE_KEY`
>
> 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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Activation
>
> **Slug:** `POLAR_GET_LICENSE_KEY_ACTIVATION`
>
> 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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> **activation\_id** `string` *required*
>
> activation id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Meter
>
> **Slug:** `POLAR_GET_METER`
>
> Get a meter by ID. Organization Access Token permissions: `meters:read` or `meters:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The meter ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Meter Quantities
>
> **Slug:** `POLAR_GET_METER_QUANTITIES`
>
> Get quantities of a meter over a time period. Organization Access Token permissions: `meters:read` or `meters:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The meter ID.
>
> **interval** `string ("year" | "month" | "week" | "day" | "hour")` *required*
>
> Interval between two timestamps.
>
> **metadata** `object`
>
> Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
>
> **timezone** `string ("Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Timbuktu" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/ComodRivadavia" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Atka" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Coyhaique" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Ensenada" | "America/Fort_Nelson" | "America/Fort_Wayne" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Knox_IN" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montreal" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Acre" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Rosario" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Shiprock" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Virgin" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/South_Pole" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Ashkhabad" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Chungking" | "Asia/Colombo" | "Asia/Dacca" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Harbin" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Istanbul" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kashgar" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macao" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tel_Aviv" | "Asia/Thimbu" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ujung_Pandang" | "Asia/Ulaanbaatar" | "Asia/Ulan_Bator" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Jan_Mayen" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/ACT" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/LHI" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/NSW" | "Australia/North" | "Australia/Perth" | "Australia/Queensland" | "Australia/South" | "Australia/Sydney" | "Australia/Tasmania" | "Australia/Victoria" | "Australia/West" | "Australia/Yancowinna" | "Brazil/Acre" | "Brazil/DeNoronha" | "Brazil/East" | "Brazil/West" | "CET" | "CST6CDT" | "Canada/Atlantic" | "Canada/Central" | "Canada/Eastern" | "Canada/Mountain" | "Canada/Newfoundland" | "Canada/Pacific" | "Canada/Saskatchewan" | "Canada/Yukon" | "Chile/Continental" | "Chile/EasterIsland" | "Cuba" | "EET" | "EST" | "EST5EDT" | "Egypt" | "Eire" | "Etc/GMT" | "Etc/GMT+0" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-0" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/GMT0" | "Etc/Greenwich" | "Etc/UCT" | "Etc/UTC" | "Etc/Universal" | "Etc/Zulu" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belfast" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Nicosia" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Tiraspol" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Factory" | "GB" | "GB-Eire" | "GMT" | "GMT+0" | "GMT-0" | "GMT0" | "Greenwich" | "HST" | "Hongkong" | "Iceland" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Iran" | "Israel" | "Jamaica" | "Japan" | "Kwajalein" | "Libya" | "MET" | "MST" | "MST7MDT" | "Mexico/BajaNorte" | "Mexico/BajaSur" | "Mexico/General" | "NZ" | "NZ-CHAT" | "Navajo" | "PRC" | "PST8PDT" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Samoa" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Yap" | "Poland" | "Portugal" | "ROC" | "ROK" | "Singapore" | "Turkey" | "UCT" | "US/Alaska" | "US/Aleutian" | "US/Arizona" | "US/Central" | "US/East-Indiana" | "US/Eastern" | "US/Hawaii" | "US/Indiana-Starke" | "US/Michigan" | "US/Mountain" | "US/Pacific" | "US/Samoa" | "UTC" | "Universal" | "W-SU" | "WET" | "Zulu")`
>
> Timezone to use for the timestamps. Default is UTC.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **end\_timestamp** `string` *required*
>
> End timestamp.
>
> **start\_timestamp** `string` *required*
>
> Start timestamp.
>
> **external\_customer\_id** `string`
>
> Filter by external customer ID.
>
> **customer\_aggregation\_function** `string ("count" | "sum" | "max" | "min" | "avg" | "unique")`
>
> If set, will first compute the quantities per customer before aggregating them using the given function. If not set, the quantities will be aggregated across all events.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Metric Dashboard
>
> **Slug:** `POLAR_GET_METRIC_DASHBOARD`
>
> Get a user-defined metric dashboard by ID. Organization Access Token permissions: `metrics:read`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The metric dashboard ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Metrics
>
> **Slug:** `POLAR_GET_METRICS`
>
> Get metrics about your orders and subscriptions. Organization Access Token permissions: `metrics:read`.
>
> #### Input Parameters
>
> **metrics** `array`
>
> List of metric slugs to focus on. When provided, only the queries needed for these metrics will be executed, improving performance. If not provided, all metrics are returned.
>
> **end\_date** `string` *required*
>
> End date.
>
> **interval** `string ("year" | "month" | "week" | "day" | "hour")` *required*
>
> Interval between two timestamps.
>
> **timezone** `string ("Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Timbuktu" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/ComodRivadavia" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Atka" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Coyhaique" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Ensenada" | "America/Fort_Nelson" | "America/Fort_Wayne" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Knox_IN" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montreal" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Acre" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Rosario" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Shiprock" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Virgin" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/South_Pole" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Ashkhabad" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Chungking" | "Asia/Colombo" | "Asia/Dacca" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Harbin" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Istanbul" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kashgar" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macao" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tel_Aviv" | "Asia/Thimbu" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ujung_Pandang" | "Asia/Ulaanbaatar" | "Asia/Ulan_Bator" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Jan_Mayen" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/ACT" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/LHI" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/NSW" | "Australia/North" | "Australia/Perth" | "Australia/Queensland" | "Australia/South" | "Australia/Sydney" | "Australia/Tasmania" | "Australia/Victoria" | "Australia/West" | "Australia/Yancowinna" | "Brazil/Acre" | "Brazil/DeNoronha" | "Brazil/East" | "Brazil/West" | "CET" | "CST6CDT" | "Canada/Atlantic" | "Canada/Central" | "Canada/Eastern" | "Canada/Mountain" | "Canada/Newfoundland" | "Canada/Pacific" | "Canada/Saskatchewan" | "Canada/Yukon" | "Chile/Continental" | "Chile/EasterIsland" | "Cuba" | "EET" | "EST" | "EST5EDT" | "Egypt" | "Eire" | "Etc/GMT" | "Etc/GMT+0" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-0" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/GMT0" | "Etc/Greenwich" | "Etc/UCT" | "Etc/UTC" | "Etc/Universal" | "Etc/Zulu" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belfast" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Nicosia" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Tiraspol" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Factory" | "GB" | "GB-Eire" | "GMT" | "GMT+0" | "GMT-0" | "GMT0" | "Greenwich" | "HST" | "Hongkong" | "Iceland" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Iran" | "Israel" | "Jamaica" | "Japan" | "Kwajalein" | "Libya" | "MET" | "MST" | "MST7MDT" | "Mexico/BajaNorte" | "Mexico/BajaSur" | "Mexico/General" | "NZ" | "NZ-CHAT" | "Navajo" | "PRC" | "PST8PDT" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Samoa" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Yap" | "Poland" | "Portugal" | "ROC" | "ROK" | "Singapore" | "Turkey" | "UCT" | "US/Alaska" | "US/Aleutian" | "US/Arizona" | "US/Central" | "US/East-Indiana" | "US/Eastern" | "US/Hawaii" | "US/Indiana-Starke" | "US/Michigan" | "US/Mountain" | "US/Pacific" | "US/Samoa" | "UTC" | "Universal" | "W-SU" | "WET" | "Zulu")`
>
> Timezone to use for the timestamps. Default is UTC.
>
> **product\_id** `string`
>
> Filter by product ID.
>
> **start\_date** `string` *required*
>
> Start date.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **billing\_type** `string`
>
> Filter by billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Metrics Limits
>
> **Slug:** `POLAR_GET_METRICS_LIMITS`
>
> Get the interval limits for the metrics endpoint. Organization Access Token permissions: `metrics:read`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Order
>
> **Slug:** `POLAR_GET_ORDER`
>
> Get an order by ID. Organization Access Token permissions: `orders:read`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The order ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Order Invoice
>
> **Slug:** `POLAR_GET_ORDER_INVOICE`
>
> Get an order's invoice data. Organization Access Token permissions: `orders:read`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The order ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Order Receipt
>
> **Slug:** `POLAR_GET_ORDER_RECEIPT`
>
> Get an order's presigned receipt PDF URL, which is null while the receipt is being generated. Organization Access Token permissions: `orders:read`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The order ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization
>
> **Slug:** `POLAR_GET_ORGANIZATION`
>
> Get an organization by ID. Organization Access Token permissions: `organizations:read` or `organizations:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment
>
> **Slug:** `POLAR_GET_PAYMENT`
>
> Get a payment by ID. Organization Access Token permissions: `payments:read`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The payment ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization
>
> **Slug:** `POLAR_GET_PORTAL_ORGANIZATION_PUBLIC`
>
> Get a customer portal's organization by slug.
>
> #### Input Parameters
>
> **slug** `string` *required*
>
> The organization slug.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Product
>
> **Slug:** `POLAR_GET_PRODUCT`
>
> Get a product by ID. Organization Access Token permissions: `products:read` or `products:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Subscription
>
> **Slug:** `POLAR_GET_SUBSCRIPTION`
>
> Get a subscription by ID. Organization Access Token permissions: `subscriptions:read` or `subscriptions:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The subscription ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook Endpoint
>
> **Slug:** `POLAR_GET_WEBHOOK_ENDPOINT`
>
> 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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The webhook endpoint ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ingest Events
>
> **Slug:** `POLAR_INGEST_EVENT`
>
> Ingest batch of events. Organization Access Token permissions: `events:write`.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar EventsIngest schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Benefit Files
>
> **Slug:** `POLAR_LIST_BENEFIT_FILES`
>
> List the downloadable files for a benefit with their download statistics. Organization Access Token permissions: `benefits:read` or `benefits:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Benefit Grants
>
> **Slug:** `POLAR_LIST_BENEFIT_GRANTS`
>
> List benefit grants across all benefits accessible to the authenticated subject. Organization Access Token permissions: `benefits:read` or `benefits:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **is\_granted** `boolean`
>
> Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **external\_customer\_id** `string`
>
> Filter by customer external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Benefit Grants
>
> **Slug:** `POLAR_LIST_BENEFIT_GRANTS_BY_BENEFIT`
>
> List the individual grants for a benefit. Organization Access Token permissions: `benefits:read` or `benefits:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **member\_id** `string`
>
> Filter by member.
>
> **is\_granted** `boolean`
>
> Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned.
>
> **customer\_id** `string`
>
> Filter by customer.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Benefits
>
> **Slug:** `POLAR_LIST_BENEFITS`
>
> List benefits. Organization Access Token permissions: `benefits:read` or `benefits:write`.
>
> #### Input Parameters
>
> **id** `string`
>
> Filter by benefit IDs.
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **type** `string`
>
> Filter by benefit type.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Filter by description.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **metadata** `object`
>
> Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
>
> **exclude\_id** `string`
>
> Exclude benefits with these IDs.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Checkout Links
>
> **Slug:** `POLAR_LIST_CHECKOUT_LINKS`
>
> List checkout links. Organization Access Token permissions: `checkout_links:read` or `checkout_links:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **product\_id** `string`
>
> Filter by product ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Checkout Sessions
>
> **Slug:** `POLAR_LIST_CHECKOUTS`
>
> List checkout sessions. Organization Access Token permissions: `checkouts:read` or `checkouts:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Filter by customer email.
>
> **status** `string`
>
> Filter by checkout session status.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **product\_id** `string`
>
> Filter by product ID.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **external\_customer\_id** `string`
>
> Filter by customer external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customer Members
>
> **Slug:** `POLAR_LIST_CUSTOMER_MEMBERS`
>
> List members of a customer by UUID without changing membership. Organization Access Token permissions: `members:read` or `members:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **role** `string ("owner" | "billing_manager" | "member")`
>
> Filter by member role.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customer Members by External ID
>
> **Slug:** `POLAR_LIST_CUSTOMER_MEMBERS_BY_EXTERNAL_ID`
>
> List members of a uniquely identified external customer without changing membership. Organization Access Token permissions: `members:read` or `members:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **role** `string ("owner" | "billing_manager" | "member")`
>
> Filter by member role.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customer Meters
>
> **Slug:** `POLAR_LIST_CUSTOMER_METERS`
>
> List customer meters. Organization Access Token permissions: `customer_meters:read`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **meter\_id** `string`
>
> Filter by meter ID.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **external\_customer\_id** `string`
>
> Filter by external customer ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customer Payment Methods
>
> **Slug:** `POLAR_LIST_CUSTOMER_PAYMENT_METHODS`
>
> Get saved payment methods of a customer. Organization Access Token permissions: `customers:read` or `customers:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customer Payment Methods by External ID
>
> **Slug:** `POLAR_LIST_CUSTOMER_PAYMENT_METHODS_BY_EXTERNAL_ID`
>
> Get saved payment methods of a customer by external ID. Organization Access Token permissions: `customers:read` or `customers:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customers
>
> **Slug:** `POLAR_LIST_CUSTOMERS`
>
> List customers. Organization Access Token permissions: `customers:read` or `customers:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **email** `string`
>
> Filter by exact email.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Filter by name, email, or external ID.
>
> **active** `boolean`
>
> Filter by active customers, i.e. customers with at least one trialing, active or past\_due subscription.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **metadata** `object`
>
> Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Seats
>
> **Slug:** `POLAR_LIST_CUSTOMER_SEATS`
>
> List customer seats for a subscription or order, including invitation and claim state.
>
> #### Input Parameters
>
> **order\_id** `string`
>
> order\_id used by this operation.
>
> **subscription\_id** `string`
>
> subscription\_id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Fields
>
> **Slug:** `POLAR_LIST_CUSTOM_FIELDS`
>
> List custom data fields configured for an organization and their validation settings.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **type** `string`
>
> Filter by custom field type.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Filter by custom field name or slug.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Discounts
>
> **Slug:** `POLAR_LIST_DISCOUNTS`
>
> List discounts. Organization Access Token permissions: `discounts:read` or `discounts:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Filter by name.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Disputes
>
> **Slug:** `POLAR_LIST_DISPUTES`
>
> List payment disputes. Organization Access Token permissions: `disputes:read` or `disputes:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **status** `string`
>
> Filter by dispute status.
>
> **sorting** `array`
>
> Sorting criteria applied in order. Prefix a criterion with `-` for descending order.
>
> **order\_id** `string`
>
> Filter by order ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Event Names
>
> **Slug:** `POLAR_LIST_EVENT_NAMES`
>
> List event names. Organization Access Token permissions: `events:read` or `events:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Query to filter event names.
>
> **source** `string`
>
> Filter by event source.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **external\_customer\_id** `string`
>
> Filter by external customer ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Events
>
> **Slug:** `POLAR_LIST_EVENTS`
>
> List events. Organization Access Token permissions: `events:read` or `events:write`.
>
> #### Input Parameters
>
> **name** `string`
>
> Filter by event name.
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **depth** `integer`
>
> Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Query to filter events.
>
> **filter** `string`
>
> Filter events following filter clauses. JSON string following the same schema a meter filter clause.
>
> **source** `string`
>
> Filter by event source.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **metadata** `object`
>
> Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
>
> **meter\_id** `string`
>
> Filter by a meter filter clause.
>
> **parent\_id** `string`
>
> When combined with depth, use this event as the anchor instead of root events.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **end\_timestamp** `string`
>
> Filter events before this timestamp.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **start\_timestamp** `string`
>
> Filter events after this timestamp.
>
> **external\_customer\_id** `string`
>
> Filter by external customer ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Event Types
>
> **Slug:** `POLAR_LIST_EVENT_TYPES`
>
> List event types with usage statistics. Organization Access Token permissions: `events:read` or `events:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Filter event types by name or label.
>
> **source** `string ("system" | "user")`
>
> Filter by event source.
>
> **sorting** `array`
>
> Sorting criteria applied in order. Prefix a criterion with `-` for descending order.
>
> **parent\_id** `string`
>
> Filter by a specific parent event ID.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **root\_events** `boolean`
>
> Return only event types with root events.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **external\_customer\_id** `string`
>
> Filter by external customer ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Files
>
> **Slug:** `POLAR_LIST_FILES`
>
> List files. Organization Access Token permissions: `files:read` or `files:write`.
>
> #### Input Parameters
>
> **ids** `string`
>
> Filter by file ID.
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List License Keys
>
> **Slug:** `POLAR_LIST_LICENSE_KEYS`
>
> 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`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **status** `string`
>
> Filter by license key status.
>
> **benefit\_id** `string`
>
> Filter by benefit ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Meters
>
> **Slug:** `POLAR_LIST_METERS`
>
> List meters. Organization Access Token permissions: `meters:read` or `meters:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Filter by name.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **metadata** `object`
>
> Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
>
> **is\_archived** `boolean`
>
> Filter on archived meters.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Metric Dashboards
>
> **Slug:** `POLAR_LIST_METRIC_DASHBOARDS`
>
> List user-defined metric dashboards. Organization Access Token permissions: `metrics:read`.
>
> #### Input Parameters
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Orders
>
> **Slug:** `POLAR_LIST_ORDERS`
>
> List orders. Organization Access Token permissions: `orders:read`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **status** `string`
>
> Filter by order status.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **metadata** `object`
>
> Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
>
> **product\_id** `string`
>
> Filter by product ID.
>
> **checkout\_id** `string`
>
> Filter by checkout ID.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **discount\_id** `string`
>
> Filter by discount ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **created\_after** `string`
>
> Only include orders created after this date
>
> **created\_before** `string`
>
> Only include orders created before this date
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **subscription\_id** `string`
>
> Filter by subscription ID.
>
> **external\_customer\_id** `string`
>
> Filter by customer external ID.
>
> **product\_billing\_type** `string`
>
> Filter by product billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organizations
>
> **Slug:** `POLAR_LIST_ORGANIZATIONS`
>
> List organizations. Organization Access Token permissions: `organizations:read` or `organizations:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **slug** `string`
>
> Filter by slug.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payments
>
> **Slug:** `POLAR_LIST_PAYMENTS`
>
> List payments. Organization Access Token permissions: `payments:read`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **method** `string`
>
> Filter by payment method.
>
> **status** `string`
>
> Filter by payment status.
>
> **sorting** `array`
>
> Sorting criteria applied in order. Prefix a criterion with `-` for descending order.
>
> **order\_id** `string`
>
> Filter by order ID.
>
> **checkout\_id** `string`
>
> Filter by checkout ID.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **customer\_email** `string`
>
> Filter by customer email.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Products
>
> **Slug:** `POLAR_LIST_PRODUCTS`
>
> List products. Organization Access Token permissions: `products:read` or `products:write`.
>
> #### Input Parameters
>
> **id** `string`
>
> Filter by product ID.
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Filter by product name.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **metadata** `object`
>
> Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
>
> **benefit\_id** `string`
>
> Filter products granting specific benefit.
>
> **visibility** `array`
>
> Filter by visibility.
>
> **is\_archived** `boolean`
>
> Filter on archived products.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **is\_recurring** `boolean`
>
> Filter on recurring products. If `true`, only subscriptions tiers are returned. If `false`, only one-time purchase products are returned.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Refunds
>
> **Slug:** `POLAR_LIST_REFUNDS`
>
> List refunds. Organization Access Token permissions: `refunds:read` or `refunds:write`.
>
> #### Input Parameters
>
> **id** `string`
>
> Filter by refund ID.
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **order\_id** `string`
>
> Filter by order ID.
>
> **succeeded** `boolean`
>
> Filter by `succeeded`.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **subscription\_id** `string`
>
> Filter by subscription ID.
>
> **external\_customer\_id** `string`
>
> Filter by customer external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subscriptions
>
> **Slug:** `POLAR_LIST_SUBSCRIPTIONS`
>
> List subscriptions. Organization Access Token permissions: `subscriptions:read` or `subscriptions:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **active** `boolean`
>
> Filter by active or inactive subscription.
>
> **status** `string`
>
> Filter by subscription status.
>
> **sorting** `array`
>
> Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
>
> **metadata** `object`
>
> Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
>
> **product\_id** `string`
>
> Filter by product ID.
>
> **customer\_id** `string`
>
> Filter by customer ID.
>
> **discount\_id** `string`
>
> Filter by discount ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **started\_after** `string`
>
> Only include subscriptions started after this date.
>
> **started\_before** `string`
>
> Only include subscriptions started before this date.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> **canceled\_at\_after** `string`
>
> Filter by cancellation date (after or equal to).
>
> **canceled\_at\_before** `string`
>
> Filter by cancellation date (before or equal to).
>
> **cancel\_at\_period\_end** `boolean`
>
> Filter by subscriptions that are set to cancel at period end.
>
> **external\_customer\_id** `string`
>
> Filter by customer external ID.
>
> **customer\_cancellation\_reason** `string`
>
> Filter by customer cancellation reason.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhook Deliveries
>
> **Slug:** `POLAR_LIST_WEBHOOK_DELIVERIES`
>
> List webhook deliveries. Organization Access Token permissions: `webhooks:read` or `webhooks:write`.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **query** `string`
>
> Query to filter webhook deliveries.
>
> **succeeded** `boolean`
>
> Filter by delivery success status.
>
> **event\_type** `string`
>
> Filter by webhook event type.
>
> **endpoint\_id** `string`
>
> Filter by webhook endpoint ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **end\_timestamp** `string`
>
> Filter deliveries before this timestamp.
>
> **http\_code\_class** `string ("2xx" | "3xx" | "4xx" | "5xx")`
>
> Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx).
>
> **start\_timestamp** `string`
>
> Filter deliveries after this timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhook Endpoints
>
> **Slug:** `POLAR_LIST_WEBHOOK_ENDPOINTS`
>
> 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.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, defaults to 1.
>
> **limit** `integer`
>
> Size of a page, defaults to 10. Maximum is 100.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
>
> **organization\_id** `string`
>
> Filter by organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Redeliver Webhook Event
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The webhook event ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resend Invitation
>
> **Slug:** `POLAR_RESEND_CUSTOMER_SEAT_INVITATION`
>
> Resend the invitation email for an unclaimed customer seat. This triggers an external email delivery and should not be retried automatically.
>
> #### Input Parameters
>
> **seat\_id** `string` *required*
>
> seat\_id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Revoke Seat
>
> **Slug:** `POLAR_REVOKE_CUSTOMER_SEAT`
>
> Permanently revoke a customer seat by ID. Verify the seat before removing access.
>
> #### Input Parameters
>
> **seat\_id** `string` *required*
>
> seat\_id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Revoke Subscription
>
> **Slug:** `POLAR_REVOKE_SUBSCRIPTION`
>
> Revoke a subscription, i.e cancel immediately. This irreversibly revokes the subscription immediately. Organization Access Token permissions: `subscriptions:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The subscription ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rotate License Key
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Benefit
>
> **Slug:** `POLAR_UPDATE_BENEFIT`
>
> Update a benefit. Organization Access Token permissions: `benefits:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> **body** `string` *required*
>
> Request payload matching the exact Polar Benefit Update schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Checkout Session
>
> **Slug:** `POLAR_UPDATE_CHECKOUT`
>
> Update a checkout session. Organization Access Token permissions: `checkouts:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The checkout session ID.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar CheckoutUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Checkout Session from Client
>
> **Slug:** `POLAR_UPDATE_CHECKOUT_BY_CLIENT_SECRET`
>
> Update a checkout session by client secret.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar CheckoutUpdatePublic schema.
>
> **client\_secret** `string` *required*
>
> The checkout session client secret.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Checkout Link
>
> **Slug:** `POLAR_UPDATE_CHECKOUT_LINK`
>
> Update a checkout link. Organization Access Token permissions: `checkout_links:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The checkout link ID.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar CheckoutLinkUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Customer
>
> **Slug:** `POLAR_UPDATE_CUSTOMER`
>
> Update a customer. Organization Access Token permissions: `customers:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar CustomerUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Customer by External ID
>
> **Slug:** `POLAR_UPDATE_CUSTOMER_BY_EXTERNAL_ID`
>
> Update a customer by external ID. Organization Access Token permissions: `customers:write`.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar CustomerUpdateExternalID schema.
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Customer Member
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The customer ID.
>
> **body** `object` *required*
>
> Member fields to update.
>
> **member\_id** `string` *required*
>
> The member ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Customer Member by External ID
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Member fields to update.
>
> **external\_id** `string` *required*
>
> The customer external ID.
>
> **member\_external\_id** `string` *required*
>
> The member external ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Field
>
> **Slug:** `POLAR_UPDATE_CUSTOM_FIELD`
>
> Update an organization custom field's label, validation, or data-collection settings.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The custom field ID.
>
> **body** `string` *required*
>
> Request payload matching the exact Polar CustomFieldUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Discount
>
> **Slug:** `POLAR_UPDATE_DISCOUNT`
>
> Update a discount. Organization Access Token permissions: `discounts:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The discount ID.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar DiscountUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Event Type
>
> **Slug:** `POLAR_UPDATE_EVENT_TYPE`
>
> Update an event type's label and optionally its dynamic label selector. Organization Access Token permissions: `events:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The event type ID.
>
> **body** `object` *required*
>
> Request payload matching Polar's EventTypeUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update File
>
> **Slug:** `POLAR_UPDATE_FILE`
>
> Update a file's name or version. Organization Access Token permissions: `files:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The file ID.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar FilePatch schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update License Key
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> **usage** `integer`
>
> Current license key usage count.
>
> **status** `string ("granted" | "revoked" | "disabled")`
>
> New license key status.
>
> **expires\_at** `string`
>
> Expiration timestamp, or null for no expiration.
>
> **limit\_usage** `integer`
>
> Maximum usage count, or null for no usage limit.
>
> **limit\_activations** `integer`
>
> Maximum number of activations, or null for no activation limit.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Meter
>
> **Slug:** `POLAR_UPDATE_METER`
>
> Update a meter. Organization Access Token permissions: `meters:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The meter ID.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar MeterUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Metric Dashboard
>
> **Slug:** `POLAR_UPDATE_METRIC_DASHBOARD`
>
> Update a user-defined metric dashboard. Organization Access Token permissions: `metrics:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The metric dashboard ID.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar MetricDashboardUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Order
>
> **Slug:** `POLAR_UPDATE_ORDER`
>
> Update an order's billing name or billing address; country and state cannot be updated. Organization Access Token permissions: `orders:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The order ID.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar OrderUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization
>
> **Slug:** `POLAR_UPDATE_ORGANIZATION`
>
> Update an organization. Organization Access Token permissions: `organizations:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar OrganizationUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Product
>
> **Slug:** `POLAR_UPDATE_PRODUCT`
>
> Update a product. Organization Access Token permissions: `products:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar ProductUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Product Benefits
>
> **Slug:** `POLAR_UPDATE_PRODUCT_BENEFITS`
>
> Update benefits granted by a product. Organization Access Token permissions: `products:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> id used by this operation.
>
> **body** `object` *required*
>
> Request payload matching the exact Polar ProductBenefitsUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Subscription
>
> **Slug:** `POLAR_UPDATE_SUBSCRIPTION`
>
> Update a subscription. Organization Access Token permissions: `subscriptions:write`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The subscription ID.
>
> **body** `string` *required*
>
> Request payload matching the exact Polar SubscriptionUpdate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook Endpoint
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The webhook endpoint ID.
>
> **url** `string`
>
> Destination URL where Polar sends webhook events.
>
> **name** `string`
>
> An optional name for the webhook endpoint to help organize and identify it.
>
> **events** `array`
>
> Event types that trigger this webhook endpoint.
>
> **format** `string ("raw" | "discord" | "slack")`
>
> Webhook payload format.
>
> **enabled** `boolean`
>
> Whether the webhook endpoint is enabled.
>
> **api\_version** `string ("2026-04" | "2026-10")`
>
> The API version that'll be used in event payloads.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate License Key
>
> **Slug:** `POLAR_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`.
>
> #### Input Parameters
>
> **key** `string` *required*
>
> Sensitive license key value.
>
> **benefit\_id** `string`
>
> Benefit ID the license key must belong to.
>
> **conditions** `object`
>
> Key-value object allowing you to set conditions that must match when validating the license key.  The key must be a string with a maximum length of **40 characters**. The value must be either:  \* A string with a maximum length of **500 characters** \* An integer \* A floating-point number \* A boolean  You can store up to **50 key-value pairs**.
>
> **customer\_id** `string`
>
> Customer ID the license key must belong to.
>
> **activation\_id** `string`
>
> License key activation ID.
>
> **increment\_usage** `integer`
>
> Non-negative amount to add to the license key usage count.
>
> **organization\_id** `string` *required*
>
> Polar organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate License Key
>
> **Slug:** `POLAR_VALIDATE_LICENSE_KEY_PUBLIC`
>
> Validate a license key and optionally increment its usage count.
>
> #### Input Parameters
>
> **body** `object` *required*
>
> Request payload matching the exact Polar LicenseKeyValidate schema.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
