--- canonical_url: "https://docs.composio.dev/toolkits/polar" markdown_url: "https://docs.composio.dev/toolkits/polar.md" product: "platform" version: null last_updated: null --- # Polar Polar is a merchant-of-record platform for products, checkouts, customers, subscriptions, orders, benefits, metrics, and customer portals. - **Category:** payment processing - **Auth:** OAUTH2, API_KEY, BEARER_TOKEN, NO_AUTH - **Composio-managed OAuth available?** No - **Tools:** 181 - **Triggers:** 0 - **Slug:** `POLAR` - **Version:** 00000000_00 ## Tools ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The dispute ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | Yes | Sensitive license key value. | | `meta` | object | No | 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 | Yes | Human-readable activation label. | | `conditions` | object | No | 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 | Yes | Polar organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar LicenseKeyActivate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Portal Member **Slug:** `POLAR_ADD_PORTAL_MEMBER` Add a customer portal member. Requires a member session with the owner or billing manager role; customer sessions are not accepted. Use a unique, controlled member identity and verify the returned member. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Member creation payload. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Customer Payment Method **Slug:** `POLAR_ADD_PORTAL_PAYMENT_METHOD` Add a payment method to the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar CustomerPaymentMethodCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar SeatAssign schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Assign Portal Seat **Slug:** `POLAR_ASSIGN_PORTAL_SEAT` Assign a seat using an authenticated customer or member session. 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Seat assignment payload. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel Subscription **Slug:** `POLAR_CANCEL_PORTAL_SUBSCRIPTION` Cancel a subscription of the authenticated customer. This changes its cancellation state and can end access according to the subscription terms. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The subscription ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Email Change Token **Slug:** `POLAR_CHECK_PORTAL_EMAIL_UPDATE` Check if an email change verification token is still valid. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `token` | string | Yes | token used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Claim Seat **Slug:** `POLAR_CLAIM_CUSTOMER_SEAT` Claim a customer seat without authentication using a one-time invitation token. This consumes the token, allocates access, and returns a customer session token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar SeatClaim schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Complete File Upload **Slug:** `POLAR_COMPLETE_FILE_UPLOAD` Complete a file upload. Organization Access Token permissions: `files:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The file ID. | | `body` | object | Yes | Request payload matching the exact Polar FileUploadCompleted schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar CheckoutConfirmStripe schema. | | `client_secret` | string | Yes | The checkout session client secret. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Confirm Customer Payment Method **Slug:** `POLAR_CONFIRM_PORTAL_PAYMENT_METHOD` Confirm a payment method for the authenticated customer. This may trigger payment or finalize an existing transaction. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar CustomerPaymentMethodConfirm schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Confirm Retry Payment **Slug:** `POLAR_CONFIRM_PORTAL_RETRY_PAYMENT` Confirm a retry payment using a Stripe confirmation token. This may trigger payment or finalize an existing transaction. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | | `body` | object | Yes | Request payload matching the exact Polar CustomerOrderConfirmPayment schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Request payload matching the exact Polar BenefitCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Checkout Session **Slug:** `POLAR_CREATE_CHECKOUT` Create a checkout session. Organization Access Token permissions: `checkouts:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar CheckoutCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Checkout Link **Slug:** `POLAR_CREATE_CHECKOUT_LINK` Create a checkout link. Organization Access Token permissions: `checkout_links:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Request payload matching the exact Polar CheckoutLinkCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Customer **Slug:** `POLAR_CREATE_CUSTOMER` Create a customer. Organization Access Token permissions: `customers:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Request payload matching the exact Polar CustomerCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | | `body` | object | Yes | The member to add to the customer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | The member to add to the customer. | | `external_id` | string | Yes | The customer external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Customer Session **Slug:** `POLAR_CREATE_CUSTOMER_SESSION` Create a customer session. Organization Access Token permissions: `customer_sessions:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Request payload matching the exact Polar Customer Session Create schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Custom Field **Slug:** `POLAR_CREATE_CUSTOM_FIELD` Create an organization custom field for collecting structured customer or checkout data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Request payload matching the exact Polar CustomFieldCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Discount **Slug:** `POLAR_CREATE_DISCOUNT` Create a discount. Organization Access Token permissions: `discounts:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Request payload matching the exact Polar DiscountCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create File **Slug:** `POLAR_CREATE_FILE` Create a file. Organization Access Token permissions: `files:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Request payload matching the exact Polar FileCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Meter **Slug:** `POLAR_CREATE_METER` Create a meter. Organization Access Token permissions: `meters:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar MeterCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Metric Dashboard **Slug:** `POLAR_CREATE_METRIC_DASHBOARD` Create a user-defined metric dashboard. Organization Access Token permissions: `metrics:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar MetricDashboardCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar OrderCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Organization **Slug:** `POLAR_CREATE_ORGANIZATION` Create an organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar OrganizationCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Product **Slug:** `POLAR_CREATE_PRODUCT` Create a product. Organization Access Token permissions: `products:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Request payload matching the exact Polar ProductCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Refund **Slug:** `POLAR_CREATE_REFUND` Create a refund. Organization Access Token permissions: `refunds:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar RefundCreate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Subscription **Slug:** `POLAR_CREATE_SUBSCRIPTION` Create a subscription programmatically. Organization Access Token permissions: `subscriptions:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | Request payload matching the exact Polar Subscription Create schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | The URL where the webhook events will be sent. | | `name` | string | No | An optional name for the webhook endpoint to help organize and identify it. | | `events` | array | Yes | The events that will trigger the webhook. | | `format` | string ("raw" | "discord" | "slack") | Yes | The format of the webhook payload. | | `api_version` | string ("2026-04" | "2026-10") | No | The API version that'll be used in event payloads. | | `organization_id` | string | No | The organization ID associated with the webhook endpoint. **Required unless you use an organization token.** | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | Yes | Sensitive license key value. | | `activation_id` | string | Yes | License key activation ID. | | `organization_id` | string | Yes | Polar organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Deactivate License Key **Slug:** `POLAR_DEACTIVATE_LICENSE_KEY_PUBLIC` Deactivate a license key instance. The identified installation immediately loses its activation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar LicenseKeyDeactivate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Checkout Link **Slug:** `POLAR_DELETE_CHECKOUT_LINK` Delete a checkout link. Organization Access Token permissions: `checkout_links:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The checkout link ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Customer **Slug:** `POLAR_DELETE_CUSTOMER` Delete a customer. Organization Access Token permissions: `customers:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | | `anonymize` | boolean | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `anonymize` | boolean | No | If true, also anonymize the customer's personal data for GDPR compliance. | | `external_id` | string | Yes | The customer external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | | `member_id` | string | Yes | The member ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_id` | string | Yes | The customer external ID. | | `member_external_id` | string | Yes | The member external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Custom Field **Slug:** `POLAR_DELETE_CUSTOM_FIELD` Permanently delete a custom field by ID. Verify the field before deletion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The custom field ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Discount **Slug:** `POLAR_DELETE_DISCOUNT` Delete a discount. Organization Access Token permissions: `discounts:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The discount ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete File **Slug:** `POLAR_DELETE_FILE` Delete a file. Organization Access Token permissions: `files:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Metric Dashboard **Slug:** `POLAR_DELETE_METRIC_DASHBOARD` Delete a user-defined metric dashboard. Organization Access Token permissions: `metrics:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The metric dashboard ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Customer Payment Method **Slug:** `POLAR_DELETE_PORTAL_PAYMENT_METHOD` Delete a payment method from the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Product **Slug:** `POLAR_DELETE_PRODUCT` Delete a product. Organization Access Token permissions: `products:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Webhook Endpoint **Slug:** `POLAR_DELETE_WEBHOOK_ENDPOINT` Delete a webhook endpoint. Organization Access Token permissions: `webhooks:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The webhook endpoint ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Customers **Slug:** `POLAR_EXPORT_CUSTOMERS` Export customers as a CSV file. Organization Access Token permissions: `customers:read` or `customers:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Metrics **Slug:** `POLAR_EXPORT_METRICS` Export metrics as a CSV file. Organization Access Token permissions: `metrics:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `metrics` | array | No | List of metric slugs to include in the export. If not provided, all metrics are exported. | | `end_date` | string | Yes | End date. | | `interval` | string ("year" | "month" | "week" | "day" | "hour") | Yes | 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") | No | Timezone to use for the timestamps. Default is UTC. | | `product_id` | string | No | Filter by product ID. | | `start_date` | string | Yes | Start date. | | `customer_id` | string | No | Filter by customer ID. | | `billing_type` | string | No | 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 | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Orders **Slug:** `POLAR_EXPORT_ORDERS` Export orders as a CSV file. Organization Access Token permissions: `orders:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | string | No | Filter by order status. | | `columns` | string | No | Columns to include in the CSV, in order. Defaults to email, created_at, product, net_amount, currency, status and invoice_number. | | `timezone` | string | No | Time zone used to render dates in the CSV. | | `product_id` | string | No | Filter by product ID. | | `created_after` | string | No | Only include orders created after this date. Must include a UTC offset. | | `created_before` | string | No | Only include orders created before this date. Must include a UTC offset. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Subscriptions **Slug:** `POLAR_EXPORT_SUBSCRIPTIONS` Export subscriptions as a CSV file. Organization Access Token permissions: `subscriptions:read` or `subscriptions:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | string | No | Filter by subscription status. | | `columns` | string | No | Columns to include in the CSV, in order. Defaults to email, started_at, product, amount, currency, status and recurring_interval. | | `timezone` | string | No | Time zone used to render dates in the CSV. | | `product_id` | string | No | Filter by product ID. | | `started_after` | string | No | Only include subscriptions started after this date. Must include a UTC offset. | | `started_before` | string | No | Only include subscriptions started before this date. Must include a UTC offset. | | `organization_id` | string | No | Filter by organization ID. | | `cancel_at_period_end` | boolean | No | Filter by subscriptions that are set to cancel at period end. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | | `body` | object | No | Schema to finalize a draft order and trigger an off-session charge. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Order Invoice **Slug:** `POLAR_GENERATE_ORDER_INVOICE` Trigger generation of an order's invoice. Organization Access Token permissions: `orders:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Order Invoice **Slug:** `POLAR_GENERATE_PORTAL_ORDER_INVOICE` Trigger generation of an order's invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Benefit **Slug:** `POLAR_GET_BENEFIT` Get a benefit by ID. Organization Access Token permissions: `benefits:read` or `benefits:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Checkout Session **Slug:** `POLAR_GET_CHECKOUT` Get a checkout session by ID. Organization Access Token permissions: `checkouts:read` or `checkouts:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The checkout session ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Checkout Session from Client **Slug:** `POLAR_GET_CHECKOUT_BY_CLIENT_SECRET` Get a checkout session by client secret. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_secret` | string | Yes | The checkout session client secret. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The checkout link ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer **Slug:** `POLAR_GET_CUSTOMER` Get a customer by ID. Organization Access Token permissions: `customers:read` or `customers:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_id` | string | Yes | The customer external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | | `member_id` | string | Yes | The member ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_id` | string | Yes | The customer external ID. | | `member_external_id` | string | Yes | The member external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer Meter **Slug:** `POLAR_GET_CUSTOMER_METER` Get a customer meter by ID. Organization Access Token permissions: `customer_meters:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer meter ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Claim Info **Slug:** `POLAR_GET_CUSTOMER_SEAT_CLAIM_INFO` Inspect a one-time customer-seat invitation before claiming it, including the customer and subscription context. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invitation_token` | string | Yes | invitation_token used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `external_id` | string | Yes | The customer external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Custom Field **Slug:** `POLAR_GET_CUSTOM_FIELD` Get one organization custom field and its validation settings by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The custom field ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Discount **Slug:** `POLAR_GET_DISCOUNT` Get a discount by ID. Organization Access Token permissions: `discounts:read` or `discounts:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The discount ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dispute **Slug:** `POLAR_GET_DISPUTE` Get a payment dispute by ID. Organization Access Token permissions: `disputes:read` or `disputes:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The dispute ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Event **Slug:** `POLAR_GET_EVENT` Get an event by ID. Organization Access Token permissions: `events:read` or `events:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The event ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | | `activation_id` | string | Yes | activation id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Meter **Slug:** `POLAR_GET_METER` Get a meter by ID. Organization Access Token permissions: `meters:read` or `meters:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The meter ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The meter ID. | | `interval` | string ("year" | "month" | "week" | "day" | "hour") | Yes | Interval between two timestamps. | | `metadata` | object | No | 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") | No | Timezone to use for the timestamps. Default is UTC. | | `customer_id` | string | No | Filter by customer ID. | | `end_timestamp` | string | Yes | End timestamp. | | `start_timestamp` | string | Yes | Start timestamp. | | `external_customer_id` | string | No | Filter by external customer ID. | | `customer_aggregation_function` | string ("count" | "sum" | "max" | "min" | "avg" | "unique") | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Metric Dashboard **Slug:** `POLAR_GET_METRIC_DASHBOARD` Get a user-defined metric dashboard by ID. Organization Access Token permissions: `metrics:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The metric dashboard ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Metrics **Slug:** `POLAR_GET_METRICS` Get metrics about your orders and subscriptions. Organization Access Token permissions: `metrics:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `metrics` | array | No | 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 | Yes | End date. | | `interval` | string ("year" | "month" | "week" | "day" | "hour") | Yes | 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") | No | Timezone to use for the timestamps. Default is UTC. | | `product_id` | string | No | Filter by product ID. | | `start_date` | string | Yes | Start date. | | `customer_id` | string | No | Filter by customer ID. | | `billing_type` | string | No | 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 | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Metrics Limits **Slug:** `POLAR_GET_METRICS_LIMITS` Get the interval limits for the metrics endpoint. Organization Access Token permissions: `metrics:read`. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order **Slug:** `POLAR_GET_ORDER` Get an order by ID. Organization Access Token permissions: `orders:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order Invoice **Slug:** `POLAR_GET_ORDER_INVOICE` Get an order's invoice data. Organization Access Token permissions: `orders:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order Receipt **Slug:** `POLAR_GET_ORDER_RECEIPT` Get a presigned URL to download an order's receipt PDF. Organization Access Token permissions: `orders:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Organization **Slug:** `POLAR_GET_ORGANIZATION` Get an organization by ID. Organization Access Token permissions: `organizations:read` or `organizations:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Payment **Slug:** `POLAR_GET_PAYMENT` Get a payment by ID. Organization Access Token permissions: `payments:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The payment ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Benefit Grant **Slug:** `POLAR_GET_PORTAL_BENEFIT_GRANT` Get a benefit grant by ID for the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The benefit grant ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer **Slug:** `POLAR_GET_PORTAL_CUSTOMER` Get authenticated customer. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get License Key **Slug:** `POLAR_GET_PORTAL_LICENSE_KEY` Get a license key. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer Meter **Slug:** `POLAR_GET_PORTAL_METER` Get a meter by ID for the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer meter ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order **Slug:** `POLAR_GET_PORTAL_ORDER` Get an order by ID for the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order Invoice **Slug:** `POLAR_GET_PORTAL_ORDER_INVOICE` Get an order's invoice data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order Payment Status **Slug:** `POLAR_GET_PORTAL_ORDER_PAYMENT_STATUS` Get the current payment status for an order. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Order Receipt **Slug:** `POLAR_GET_PORTAL_ORDER_RECEIPT` Get a presigned URL to download an order's receipt PDF. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Organization **Slug:** `POLAR_GET_PORTAL_ORGANIZATION_PUBLIC` Get a customer portal's organization by slug. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `slug` | string | Yes | The organization slug. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Subscription **Slug:** `POLAR_GET_PORTAL_SUBSCRIPTION` Get a subscription for the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The subscription ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Authenticated Portal User **Slug:** `POLAR_GET_PORTAL_USER` Get information about the currently authenticated portal user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Portal Wallet **Slug:** `POLAR_GET_PORTAL_WALLET` Get a wallet by ID using an authenticated customer or member session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The wallet ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Product **Slug:** `POLAR_GET_PRODUCT` Get a product by ID. Organization Access Token permissions: `products:read` or `products:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Subscription **Slug:** `POLAR_GET_SUBSCRIPTION` Get a subscription by ID. Organization Access Token permissions: `subscriptions:read` or `subscriptions:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The subscription ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The webhook endpoint ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Ingest Events **Slug:** `POLAR_INGEST_EVENT` Ingest batch of events. Organization Access Token permissions: `events:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar EventsIngest schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Introspect Customer Session **Slug:** `POLAR_INTROSPECT_PORTAL_SESSION` Introspect the current session and return its information. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | array | No | 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 | No | Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned. | | `customer_id` | string | No | Filter by customer ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | | `external_customer_id` | string | No | Filter by customer external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `member_id` | string | No | Filter by member. | | `is_granted` | boolean | No | Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned. | | `customer_id` | string | No | Filter by customer. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Benefits **Slug:** `POLAR_LIST_BENEFITS` List benefits. Organization Access Token permissions: `benefits:read` or `benefits:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Filter by benefit IDs. | | `page` | integer | No | Page number, defaults to 1. | | `type` | string | No | Filter by benefit type. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter by description. | | `sorting` | array | No | 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 | No | Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`. | | `exclude_id` | string | No | Exclude benefits with these IDs. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Checkout Links **Slug:** `POLAR_LIST_CHECKOUT_LINKS` List checkout links. Organization Access Token permissions: `checkout_links:read` or `checkout_links:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | array | No | 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 | No | Filter by product ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Checkout Sessions **Slug:** `POLAR_LIST_CHECKOUTS` List checkout sessions. Organization Access Token permissions: `checkouts:read` or `checkouts:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter by customer email. | | `status` | string | No | Filter by checkout session status. | | `sorting` | array | No | 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 | No | Filter by product ID. | | `customer_id` | string | No | Filter by customer ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | | `external_customer_id` | string | No | Filter by customer external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | | `page` | integer | No | Page number, defaults to 1. | | `role` | string ("owner" | "billing_manager" | "member") | No | Filter by member role. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | array | No | 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 | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `role` | string ("owner" | "billing_manager" | "member") | No | Filter by member role. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | array | No | 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 | Yes | The customer external ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customer Meters **Slug:** `POLAR_LIST_CUSTOMER_METERS` List customer meters. Organization Access Token permissions: `customer_meters:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | array | No | 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 | No | Filter by meter ID. | | `customer_id` | string | No | Filter by customer ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | | `external_customer_id` | string | No | Filter by external customer ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `external_id` | string | Yes | The customer external ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customers **Slug:** `POLAR_LIST_CUSTOMERS` List customers. Organization Access Token permissions: `customers:read` or `customers:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `email` | string | No | Filter by exact email. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter by name, email, or external ID. | | `active` | boolean | No | Filter by active customers, i.e. customers with at least one trialing, active or past_due subscription. | | `sorting` | array | No | 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 | No | Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Seats **Slug:** `POLAR_LIST_CUSTOMER_SEATS` List seats assigned from organization subscriptions, including invitation and claim state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `order_id` | string | No | order_id used by this operation. | | `subscription_id` | string | No | subscription_id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Custom Fields **Slug:** `POLAR_LIST_CUSTOM_FIELDS` List custom data fields configured for an organization and their validation settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `type` | string | No | Filter by custom field type. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter by custom field name or slug. | | `sorting` | array | No | 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 | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Discounts **Slug:** `POLAR_LIST_DISCOUNTS` List discounts. Organization Access Token permissions: `discounts:read` or `discounts:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter by name. | | `sorting` | array | No | 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 | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Disputes **Slug:** `POLAR_LIST_DISPUTES` List payment disputes. Organization Access Token permissions: `disputes:read` or `disputes:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `status` | string | No | Filter by dispute status. | | `sorting` | array | No | Sorting criteria applied in order. Prefix a criterion with `-` for descending order. | | `order_id` | string | No | Filter by order ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Event Names **Slug:** `POLAR_LIST_EVENT_NAMES` List event names. Organization Access Token permissions: `events:read` or `events:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Query to filter event names. | | `source` | string | No | Filter by event source. | | `sorting` | array | No | 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 | No | Filter by customer ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | | `external_customer_id` | string | No | Filter by external customer ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Events **Slug:** `POLAR_LIST_EVENTS` List events. Organization Access Token permissions: `events:read` or `events:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Filter by event name. | | `page` | integer | No | Page number, defaults to 1. | | `depth` | integer | No | 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 | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Query to filter events. | | `filter` | string | No | Filter events following filter clauses. JSON string following the same schema a meter filter clause. | | `source` | string | No | Filter by event source. | | `sorting` | array | No | 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 | No | Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`. | | `meter_id` | string | No | Filter by a meter filter clause. | | `parent_id` | string | No | When combined with depth, use this event as the anchor instead of root events. | | `customer_id` | string | No | Filter by customer ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `end_timestamp` | string | No | Filter events before this timestamp. | | `organization_id` | string | No | Filter by organization ID. | | `start_timestamp` | string | No | Filter events after this timestamp. | | `external_customer_id` | string | No | Filter by external customer ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter event types by name or label. | | `source` | string ("system" | "user") | No | Filter by event source. | | `sorting` | array | No | Sorting criteria applied in order. Prefix a criterion with `-` for descending order. | | `parent_id` | string | No | Filter by a specific parent event ID. | | `customer_id` | string | No | Filter by customer ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `root_events` | boolean | No | Return only event types with root events. | | `organization_id` | string | No | Filter by organization ID. | | `external_customer_id` | string | No | Filter by external customer ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Files **Slug:** `POLAR_LIST_FILES` List files. Organization Access Token permissions: `files:read` or `files:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | string | No | Filter by file ID. | | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `status` | string | No | Filter by license key status. | | `benefit_id` | string | No | Filter by benefit ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Meters **Slug:** `POLAR_LIST_METERS` List meters. Organization Access Token permissions: `meters:read` or `meters:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter by name. | | `sorting` | array | No | 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 | No | Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`. | | `is_archived` | boolean | No | Filter on archived meters. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Metric Dashboards **Slug:** `POLAR_LIST_METRIC_DASHBOARDS` List user-defined metric dashboards. Organization Access Token permissions: `metrics:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Orders **Slug:** `POLAR_LIST_ORDERS` List orders. Organization Access Token permissions: `orders:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `status` | string | No | Filter by order status. | | `sorting` | array | No | 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 | No | Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`. | | `product_id` | string | No | Filter by product ID. | | `checkout_id` | string | No | Filter by checkout ID. | | `customer_id` | string | No | Filter by customer ID. | | `discount_id` | string | No | Filter by discount ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `created_after` | string | No | Only include orders created after this date | | `created_before` | string | No | Only include orders created before this date | | `organization_id` | string | No | Filter by organization ID. | | `subscription_id` | string | No | Filter by subscription ID. | | `external_customer_id` | string | No | Filter by customer external ID. | | `product_billing_type` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Organizations **Slug:** `POLAR_LIST_ORGANIZATIONS` List organizations. Organization Access Token permissions: `organizations:read` or `organizations:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `slug` | string | No | Filter by slug. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | array | No | 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 | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Payments **Slug:** `POLAR_LIST_PAYMENTS` List payments. Organization Access Token permissions: `payments:read`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `method` | string | No | Filter by payment method. | | `status` | string | No | Filter by payment status. | | `sorting` | array | No | Sorting criteria applied in order. Prefix a criterion with `-` for descending order. | | `order_id` | string | No | Filter by order ID. | | `checkout_id` | string | No | Filter by checkout ID. | | `customer_id` | string | No | Filter by customer ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `customer_email` | string | No | Filter by customer email. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Benefit Grants **Slug:** `POLAR_LIST_PORTAL_BENEFIT_GRANTS` List benefits grants of the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `type` | string | No | Filter by benefit type. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter by benefit description. | | `sorting` | array | No | 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 | No | Filter by order ID. | | `member_id` | string | No | Filter by member ID. | | `benefit_id` | string | No | Filter by benefit ID. | | `checkout_id` | string | No | Filter by checkout ID. | | `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | | `subscription_id` | string | No | Filter by subscription ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portal Claimed Subscriptions **Slug:** `POLAR_LIST_PORTAL_CLAIMED_SUBSCRIPTIONS` List subscriptions claimed through seats by the authenticated customer or member session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Downloadables **Slug:** `POLAR_LIST_PORTAL_DOWNLOADABLES` List files the authenticated customer can download through granted benefits, optionally filtered by benefit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `benefit_id` | string | No | Filter by benefit ID. | | `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List License Keys **Slug:** `POLAR_LIST_PORTAL_LICENSE_KEYS` List license keys issued to the authenticated customer, with optional organization and benefit filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `benefit_id` | string | No | Filter by a specific benefit | | `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portal Members **Slug:** `POLAR_LIST_PORTAL_MEMBERS` List customer portal members. Requires a member session with the owner or billing manager role; customer sessions are not accepted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Meters **Slug:** `POLAR_LIST_PORTAL_METERS` List meters of the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter by meter name. | | `sorting` | array | No | 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 | No | Filter by meter ID. | | `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Orders **Slug:** `POLAR_LIST_PORTAL_ORDERS` List orders of the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Search by product or organization name. | | `sorting` | array | No | 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 | No | Filter by product ID. | | `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | | `subscription_id` | string | No | Filter by subscription ID. | | `product_billing_type` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customer Payment Methods **Slug:** `POLAR_LIST_PORTAL_PAYMENT_METHODS` Get saved payment methods of the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portal Seats **Slug:** `POLAR_LIST_PORTAL_SEATS` List seats for a subscription or order available to the authenticated customer or member session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `order_id` | string | No | Order ID. | | `subscription_id` | string | No | Subscription ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Subscriptions **Slug:** `POLAR_LIST_PORTAL_SUBSCRIPTIONS` List subscriptions of the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Search by product or organization name. | | `active` | boolean | No | Filter by active or cancelled subscription. | | `sorting` | array | No | 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 | No | Filter by product ID. | | `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Portal Wallets **Slug:** `POLAR_LIST_PORTAL_WALLETS` List wallets available to the authenticated customer or member session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | array | No | 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 | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Products **Slug:** `POLAR_LIST_PRODUCTS` List products. Organization Access Token permissions: `products:read` or `products:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Filter by product ID. | | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Filter by product name. | | `sorting` | array | No | 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 | No | Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`. | | `benefit_id` | string | No | Filter products granting specific benefit. | | `visibility` | array | No | Filter by visibility. | | `is_archived` | boolean | No | Filter on archived products. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `is_recurring` | boolean | No | Filter on recurring products. If `true`, only subscriptions tiers are returned. If `false`, only one-time purchase products are returned. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Refunds **Slug:** `POLAR_LIST_REFUNDS` List refunds. Organization Access Token permissions: `refunds:read` or `refunds:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Filter by refund ID. | | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | array | No | 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 | No | Filter by order ID. | | `succeeded` | boolean | No | Filter by `succeeded`. | | `customer_id` | string | No | Filter by customer ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | | `subscription_id` | string | No | Filter by subscription ID. | | `external_customer_id` | string | No | Filter by customer external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Subscriptions **Slug:** `POLAR_LIST_SUBSCRIPTIONS` List subscriptions. Organization Access Token permissions: `subscriptions:read` or `subscriptions:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `active` | boolean | No | Filter by active or inactive subscription. | | `status` | string | No | Filter by subscription status. | | `sorting` | array | No | 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 | No | Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`. | | `product_id` | string | No | Filter by product ID. | | `customer_id` | string | No | Filter by customer ID. | | `discount_id` | string | No | Filter by discount ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `started_after` | string | No | Only include subscriptions started after this date. | | `started_before` | string | No | Only include subscriptions started before this date. | | `organization_id` | string | No | Filter by organization ID. | | `canceled_at_after` | string | No | Filter by cancellation date (after or equal to). | | `canceled_at_before` | string | No | Filter by cancellation date (before or equal to). | | `cancel_at_period_end` | boolean | No | Filter by subscriptions that are set to cancel at period end. | | `external_customer_id` | string | No | Filter by customer external ID. | | `customer_cancellation_reason` | string | No | Filter by customer cancellation reason. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhook Deliveries **Slug:** `POLAR_LIST_WEBHOOK_DELIVERIES` List webhook deliveries. Organization Access Token permissions: `webhooks:read` or `webhooks:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `query` | string | No | Query to filter webhook deliveries. | | `succeeded` | boolean | No | Filter by delivery success status. | | `event_type` | string | No | Filter by webhook event type. | | `endpoint_id` | string | No | Filter by webhook endpoint ID. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `end_timestamp` | string | No | Filter deliveries before this timestamp. | | `http_code_class` | string ("2xx" | "3xx" | "4xx" | "5xx") | No | Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx). | | `start_timestamp` | string | No | Filter deliveries after this timestamp. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhook Endpoints **Slug:** `POLAR_LIST_WEBHOOK_ENDPOINTS` List webhook endpoints. Organization Access Token permissions: `webhooks:read` or `webhooks:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number, defaults to 1. | | `limit` | integer | No | Size of a page, defaults to 10. Maximum is 100. | | `next_cursor` | string | No | Opaque continuation cursor returned by the previous call. When set, it controls the provider page value. | | `organization_id` | string | No | Filter by organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The webhook event ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Portal Member **Slug:** `POLAR_REMOVE_PORTAL_MEMBER` Permanently remove a customer portal member. Requires a member session with the owner or billing manager role; customer sessions are not accepted. Use only a disposable member; never target the sole owner or a shared production member. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The member ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Request Email Change **Slug:** `POLAR_REQUEST_PORTAL_EMAIL_UPDATE` Request an email change for the authenticated customer. This sends a verification message to the proposed address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar CustomerEmailUpdateRequest schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `seat_id` | string | Yes | seat_id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resend Portal Seat Invitation **Slug:** `POLAR_RESEND_PORTAL_SEAT_INVITATION` Resend a pending seat invitation using an authenticated customer or member session. This sends another email; use a controlled deliverable address and avoid repeated calls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `seat_id` | string | Yes | The pending seat ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Webhook Endpoint Secret **Slug:** `POLAR_RESET_WEBHOOK_SECRET` Regenerate a webhook endpoint secret. 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: `webhooks:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The webhook endpoint ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Revoke Seat **Slug:** `POLAR_REVOKE_CUSTOMER_SEAT` Permanently revoke a customer seat by ID. Verify the seat before removing access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `seat_id` | string | Yes | seat_id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Revoke Portal Seat **Slug:** `POLAR_REVOKE_PORTAL_SEAT` Permanently revoke a seat using an authenticated customer or member session. Use only a disposable seat; never target a sole owner or shared production resource. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `seat_id` | string | Yes | The seat ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The subscription ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rotate License Key **Slug:** `POLAR_ROTATE_PORTAL_LICENSE_KEY` Rotate a license key. The existing key is invalidated and cannot be recovered. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Benefit **Slug:** `POLAR_UPDATE_BENEFIT` Update a benefit. Organization Access Token permissions: `benefits:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | | `body` | string | Yes | Request payload matching the exact Polar Benefit Update schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Checkout Session **Slug:** `POLAR_UPDATE_CHECKOUT` Update a checkout session. Organization Access Token permissions: `checkouts:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The checkout session ID. | | `body` | object | Yes | Request payload matching the exact Polar CheckoutUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Checkout Session from Client **Slug:** `POLAR_UPDATE_CHECKOUT_BY_CLIENT_SECRET` Update a checkout session by client secret. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar CheckoutUpdatePublic schema. | | `client_secret` | string | Yes | The checkout session client secret. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Checkout Link **Slug:** `POLAR_UPDATE_CHECKOUT_LINK` Update a checkout link. Organization Access Token permissions: `checkout_links:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The checkout link ID. | | `body` | object | Yes | Request payload matching the exact Polar CheckoutLinkUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Customer **Slug:** `POLAR_UPDATE_CUSTOMER` Update a customer. Organization Access Token permissions: `customers:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | | `body` | object | Yes | Request payload matching the exact Polar CustomerUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar CustomerUpdateExternalID schema. | | `external_id` | string | Yes | The customer external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The customer ID. | | `body` | object | Yes | Member fields to update. | | `member_id` | string | Yes | The member ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Member fields to update. | | `external_id` | string | Yes | The customer external ID. | | `member_external_id` | string | Yes | The member external ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Custom Field **Slug:** `POLAR_UPDATE_CUSTOM_FIELD` Update an organization custom field's label, validation, or data-collection settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The custom field ID. | | `body` | string | Yes | Request payload matching the exact Polar CustomFieldUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Discount **Slug:** `POLAR_UPDATE_DISCOUNT` Update a discount. Organization Access Token permissions: `discounts:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The discount ID. | | `body` | object | Yes | Request payload matching the exact Polar DiscountUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Event Type **Slug:** `POLAR_UPDATE_EVENT_TYPE` Update an event type's label or dynamic label selector. Organization Access Token permissions: `events:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The event type ID. | | `body` | object | Yes | Request payload matching Polar's EventTypeUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update File **Slug:** `POLAR_UPDATE_FILE` Update a file. Organization Access Token permissions: `files:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The file ID. | | `body` | object | Yes | Request payload matching the exact Polar FilePatch schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | | `usage` | integer | No | Current license key usage count. | | `status` | string ("granted" | "revoked" | "disabled") | No | New license key status. | | `expires_at` | string | No | Expiration timestamp, or null for no expiration. | | `limit_usage` | integer | No | Maximum usage count, or null for no usage limit. | | `limit_activations` | integer | No | Maximum number of activations, or null for no activation limit. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Meter **Slug:** `POLAR_UPDATE_METER` Update a meter. Organization Access Token permissions: `meters:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The meter ID. | | `body` | object | Yes | Request payload matching the exact Polar MeterUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Metric Dashboard **Slug:** `POLAR_UPDATE_METRIC_DASHBOARD` Update a user-defined metric dashboard. Organization Access Token permissions: `metrics:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The metric dashboard ID. | | `body` | object | Yes | Request payload matching the exact Polar MetricDashboardUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Order **Slug:** `POLAR_UPDATE_ORDER` Update an order. Organization Access Token permissions: `orders:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | | `body` | object | Yes | Request payload matching the exact Polar OrderUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Organization **Slug:** `POLAR_UPDATE_ORGANIZATION` Update an organization. Organization Access Token permissions: `organizations:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | | `body` | object | Yes | Request payload matching the exact Polar OrganizationUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Benefit Grant **Slug:** `POLAR_UPDATE_PORTAL_BENEFIT_GRANT` Update a benefit grant for the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The benefit grant ID. | | `body` | string | Yes | Request payload matching the exact Polar CustomerBenefitGrantUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Customer **Slug:** `POLAR_UPDATE_PORTAL_CUSTOMER` Update authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar CustomerPortalCustomerUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Portal Member **Slug:** `POLAR_UPDATE_PORTAL_MEMBER` Update a customer portal member's name or role. Requires a member session with the owner or billing manager role; customer sessions are not accepted. Verify role changes against a disposable member. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The member ID. | | `body` | object | Yes | Member update payload. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Order **Slug:** `POLAR_UPDATE_PORTAL_ORDER` Update an order for the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The order ID. | | `body` | object | Yes | Request payload matching the exact Polar CustomerOrderUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Subscription **Slug:** `POLAR_UPDATE_PORTAL_SUBSCRIPTION` Update a subscription of the authenticated customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The subscription ID. | | `body` | object | Yes | Request payload matching the exact Polar CustomerSubscriptionUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Product **Slug:** `POLAR_UPDATE_PRODUCT` Update a product. Organization Access Token permissions: `products:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | | `body` | object | Yes | Request payload matching the exact Polar ProductUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Product Benefits **Slug:** `POLAR_UPDATE_PRODUCT_BENEFITS` Update benefits granted by a product. Organization Access Token permissions: `products:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | id used by this operation. | | `body` | object | Yes | Request payload matching the exact Polar ProductBenefitsUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Subscription **Slug:** `POLAR_UPDATE_SUBSCRIPTION` Update a subscription. Organization Access Token permissions: `subscriptions:write`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The subscription ID. | | `body` | string | Yes | Request payload matching the exact Polar SubscriptionUpdate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The webhook endpoint ID. | | `url` | string | No | Destination URL where Polar sends webhook events. | | `name` | string | No | An optional name for the webhook endpoint to help organize and identify it. | | `events` | array | No | Event types that trigger this webhook endpoint. | | `format` | string ("raw" | "discord" | "slack") | No | Webhook payload format. | | `enabled` | boolean | No | Whether the webhook endpoint is enabled. | | `api_version` | string ("2026-04" | "2026-10") | No | The API version that'll be used in event payloads. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | Yes | Sensitive license key value. | | `benefit_id` | string | No | Benefit ID the license key must belong to. | | `conditions` | object | No | 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 | No | Customer ID the license key must belong to. | | `activation_id` | string | No | License key activation ID. | | `increment_usage` | integer | No | Non-negative amount to add to the license key usage count. | | `organization_id` | string | Yes | Polar organization ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate License Key **Slug:** `POLAR_VALIDATE_LICENSE_KEY_PUBLIC` Validate a license key and optionally increment its usage count. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar LicenseKeyValidate schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Verify Email Change **Slug:** `POLAR_VERIFY_PORTAL_EMAIL_UPDATE` Verify and apply an email change using the token from the verification email. This changes the customer's sign-in email. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Request payload matching the exact Polar CustomerEmailUpdateVerifyRequest schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |