Skip to main content
Polar logo
  • Category: payment processing
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 134
  • Triggers: 0
  • Slug: POLAR
  • Version: 20261101_00

Tools

Slug: POLAR_ACCEPT_DISPUTEAccept a dispute, permanently conceding the chargeback and settling it as lost. Organization Access Token permissions: disputes:write.

Input Parameters

string
required
The dispute ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_ACTIVATE_LICENSE_KEYActivate 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

string
required
Sensitive license key value.
object
Key-value object allowing you to store additional information about the activation The key must be a string with a maximum length of 40 characters. The value must be either: * A string with a maximum length of 500 characters * An integer * A floating-point number * A boolean You can store up to 50 key-value pairs.
string
required
Human-readable activation label.
object
Key-value object allowing you to set conditions that must match when validating the license key. The key must be a string with a maximum length of 40 characters. The value must be either: * A string with a maximum length of 500 characters * An integer * A floating-point number * A boolean You can store up to 50 key-value pairs.
string
required
Polar organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_ACTIVATE_LICENSE_KEY_PUBLICActivate a license key instance. This consumes an activation slot until the instance is deactivated.

Input Parameters

object
required
Request payload matching the exact Polar LicenseKeyActivate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_ASSIGN_CUSTOMER_SEATAssign 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

object
required
Request payload matching the exact Polar SeatAssign schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_COMPLETE_FILE_UPLOADComplete a file upload. Organization Access Token permissions: files:write.

Input Parameters

string
required
The file ID.
object
required
Request payload matching the exact Polar FileUploadCompleted schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CONFIRM_CHECKOUT_BY_CLIENT_SECRETConfirm a checkout session by client secret. This may trigger payment or finalize an existing transaction.

Input Parameters

object
required
Request payload matching the exact Polar CheckoutConfirmStripe schema.
string
required
The checkout session client secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_BENEFITCreate a benefit, for example license keys, file downloads or Discord access. Organization Access Token permissions: benefits:write.

Input Parameters

string
required
Request payload matching the exact Polar BenefitCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_CHECKOUTCreate a checkout session. Organization Access Token permissions: checkouts:write.

Input Parameters

object
required
Request payload matching the exact Polar CheckoutCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_CUSTOMERCreate a customer. Organization Access Token permissions: customers:write.

Input Parameters

string
required
Request payload matching the exact Polar CustomerCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_CUSTOMER_MEMBERAdd 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

string
required
The customer ID.
object
required
The member to add to the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_CUSTOMER_MEMBER_BY_EXTERNAL_IDAdd 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

object
required
The member to add to the customer.
string
required
The customer external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_CUSTOM_FIELDCreate an organization custom field for collecting structured customer or checkout data.

Input Parameters

string
required
Request payload matching the exact Polar CustomFieldCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_DISCOUNTCreate a discount. Organization Access Token permissions: discounts:write.

Input Parameters

string
required
Request payload matching the exact Polar DiscountCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_FILECreate a Polar file record and obtain multipart upload details. Organization Access Token permissions: files:write.

Input Parameters

string
required
Request payload matching the exact Polar FileCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_METERCreate a meter. Organization Access Token permissions: meters:write.

Input Parameters

object
required
Request payload matching the exact Polar MeterCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_METRIC_DASHBOARDCreate a user-defined metric dashboard. Organization Access Token permissions: metrics:write.

Input Parameters

object
required
Request payload matching the exact Polar MetricDashboardCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_ORDERCreate a draft order for an off-session charge against a saved payment Organization Access Token permissions: orders:write.

Input Parameters

object
required
Request payload matching the exact Polar OrderCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_ORGANIZATIONCreate an organization using OAuth2 with the organizations:write scope.

Input Parameters

object
required
Request payload matching the exact Polar OrganizationCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_PRODUCTCreate a product. Organization Access Token permissions: products:write.

Input Parameters

string
required
Request payload matching the exact Polar ProductCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_REFUNDCreate a refund. Organization Access Token permissions: refunds:write.

Input Parameters

object
required
Request payload matching the exact Polar RefundCreate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_SUBSCRIPTIONCreate a subscription for an existing customer to a free recurring product, identified by Polar customer ID or external customer ID. Organization Access Token permissions: subscriptions:write.

Input Parameters

string
required
Request payload matching the exact Polar Subscription Create schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_CREATE_WEBHOOK_ENDPOINTCreate a webhook endpoint. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: webhooks:write.

Input Parameters

string
required
The URL where the webhook events will be sent.
string
An optional name for the webhook endpoint to help organize and identify it.
array
required
The events that will trigger the webhook.
string ("raw" | "discord" | "slack")
required
The format of the webhook payload.
string ("2026-04" | "2026-10")
The API version that’ll be used in event payloads.
string
The organization ID associated with the webhook endpoint. Required unless you use an organization token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DEACTIVATE_LICENSE_KEYDeactivate 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

string
required
Sensitive license key value.
string
required
License key activation ID.
string
required
Polar organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DEACTIVATE_LICENSE_KEY_PUBLICDeactivate a license key instance. The identified installation immediately loses its activation.

Input Parameters

object
required
Request payload matching the exact Polar LicenseKeyDeactivate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_BENEFITDelete a benefit. This also revokes every associated grant and removes user access. Organization Access Token permissions: benefits:write.

Input Parameters

string
required
id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_CUSTOMERDelete a customer. Organization Access Token permissions: customers:write.

Input Parameters

string
required
The customer ID.
boolean
If true, also anonymize the customer’s personal data for GDPR compliance. This replaces email with a hashed version, hashes name and billing name (name preserved for businesses with tax_id), clears billing address, and removes OAuth account data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_CUSTOMER_BY_EXTERNAL_IDDelete a customer by external ID. Organization Access Token permissions: customers:write.

Input Parameters

boolean
If true, also anonymize the customer’s personal data for GDPR compliance.
string
required
The customer external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_CUSTOMER_MEMBERPermanently 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

string
required
The customer ID.
string
required
The member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_CUSTOMER_MEMBER_BY_EXTERNAL_IDPermanently 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

string
required
The customer external ID.
string
required
The member external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_CUSTOM_FIELDPermanently delete a custom field by ID. Verify the field before deletion.

Input Parameters

string
required
The custom field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_DISCOUNTDelete a discount. Organization Access Token permissions: discounts:write.

Input Parameters

string
required
The discount ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_FILEDelete a file. Organization Access Token permissions: files:write.

Input Parameters

string
required
id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_METRIC_DASHBOARDDelete a user-defined metric dashboard. Organization Access Token permissions: metrics:write.

Input Parameters

string
required
The metric dashboard ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_PRODUCTDelete a product. Organization Access Token permissions: products:write.

Input Parameters

string
required
id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_DELETE_WEBHOOK_ENDPOINTDelete a webhook endpoint. Organization Access Token permissions: webhooks:write.

Input Parameters

string
required
The webhook endpoint ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_EXPORT_CUSTOMERSExport customers as a CSV file. Organization Access Token permissions: customers:read or customers:write.

Input Parameters

string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_EXPORT_METRICSExport metrics as a CSV file. Organization Access Token permissions: metrics:read.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_EXPORT_ORDERSExport orders as a CSV file. Organization Access Token permissions: orders:read.

Input Parameters

string
Filter by order status.
string
Columns to include in the CSV, in order. Defaults to email, created_at, product, net_amount, currency, status and invoice_number.
string
Time zone used to render dates in the CSV.
string
Filter by product ID.
string
Only include orders created after this date. Must include a UTC offset.
string
Only include orders created before this date. Must include a UTC offset.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_EXPORT_SUBSCRIPTIONSExport subscriptions as a CSV file. Organization Access Token permissions: subscriptions:read or subscriptions:write.

Input Parameters

string
Filter by subscription status.
string
Columns to include in the CSV, in order. Defaults to email, started_at, product, amount, currency, status and recurring_interval.
string
Time zone used to render dates in the CSV.
string
Filter by product ID.
string
Only include subscriptions started after this date. Must include a UTC offset.
string
Only include subscriptions started before this date. Must include a UTC offset.
string
Filter by organization ID.
boolean
Filter by subscriptions that are set to cancel at period end.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_FINALIZE_ORDERFinalize 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

string
required
The order ID.
object
Schema to finalize a draft order and trigger an off-session charge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GENERATE_ORDER_INVOICETrigger generation of an order’s invoice. Organization Access Token permissions: orders:read.

Input Parameters

string
required
The order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_BENEFITGet a benefit by ID. Organization Access Token permissions: benefits:read or benefits:write.

Input Parameters

string
required
id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CHECKOUTGet a checkout session by ID. Organization Access Token permissions: checkouts:read or checkouts:write.

Input Parameters

string
required
The checkout session ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CHECKOUT_BY_CLIENT_SECRETGet a checkout session by client secret.

Input Parameters

string
required
The checkout session client secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CUSTOMERGet a customer by ID. Organization Access Token permissions: customers:read or customers:write.

Input Parameters

string
required
The customer ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CUSTOMER_BY_EXTERNAL_IDGet a customer by external ID. Organization Access Token permissions: customers:read or customers:write.

Input Parameters

string
required
The customer external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CUSTOMER_MEMBERGet a member by customer UUID and member UUID without changing membership. Organization Access Token permissions: members:read or members:write.

Input Parameters

string
required
The customer ID.
string
required
The member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CUSTOMER_MEMBER_BY_EXTERNAL_IDGet 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

string
required
The customer external ID.
string
required
The member external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CUSTOMER_METERGet a customer meter by ID. Organization Access Token permissions: customer_meters:read.

Input Parameters

string
required
The customer meter ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CUSTOMER_STATEGet a customer state by ID. Organization Access Token permissions: customers:read or customers:write.

Input Parameters

string
required
The customer ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CUSTOMER_STATE_BY_EXTERNAL_IDGet a customer state by external ID. Organization Access Token permissions: customers:read or customers:write.

Input Parameters

string
required
The customer external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_CUSTOM_FIELDGet one organization custom field and its validation settings by ID.

Input Parameters

string
required
The custom field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_DISCOUNTGet a discount by ID. Organization Access Token permissions: discounts:read or discounts:write.

Input Parameters

string
required
The discount ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_DISPUTEGet a payment dispute by ID. Organization Access Token permissions: disputes:read or disputes:write.

Input Parameters

string
required
The dispute ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_EVENTGet an event by ID. Organization Access Token permissions: events:read or events:write.

Input Parameters

string
required
The event ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_LICENSE_KEYGet 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

string
required
id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_LICENSE_KEY_ACTIVATIONGet 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

string
required
id used by this operation.
string
required
activation id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_METERGet a meter by ID. Organization Access Token permissions: meters:read or meters:write.

Input Parameters

string
required
The meter ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_METER_QUANTITIESGet quantities of a meter over a time period. Organization Access Token permissions: meters:read or meters:write.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_METRIC_DASHBOARDGet a user-defined metric dashboard by ID. Organization Access Token permissions: metrics:read.

Input Parameters

string
required
The metric dashboard ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_METRICSGet metrics about your orders and subscriptions. Organization Access Token permissions: metrics:read.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_METRICS_LIMITSGet the interval limits for the metrics endpoint. Organization Access Token permissions: metrics:read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_ORDERGet an order by ID. Organization Access Token permissions: orders:read.

Input Parameters

string
required
The order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_ORDER_INVOICEGet an order’s invoice data. Organization Access Token permissions: orders:read.

Input Parameters

string
required
The order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_ORDER_RECEIPTGet an order’s presigned receipt PDF URL, which is null while the receipt is being generated. Organization Access Token permissions: orders:read.

Input Parameters

string
required
The order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_ORGANIZATIONGet an organization by ID. Organization Access Token permissions: organizations:read or organizations:write.

Input Parameters

string
required
id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_PAYMENTGet a payment by ID. Organization Access Token permissions: payments:read.

Input Parameters

string
required
The payment ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_PORTAL_ORGANIZATION_PUBLICGet a customer portal’s organization by slug.

Input Parameters

string
required
The organization slug.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_PRODUCTGet a product by ID. Organization Access Token permissions: products:read or products:write.

Input Parameters

string
required
id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_SUBSCRIPTIONGet a subscription by ID. Organization Access Token permissions: subscriptions:read or subscriptions:write.

Input Parameters

string
required
The subscription ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_GET_WEBHOOK_ENDPOINTGet 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

string
required
The webhook endpoint ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_INGEST_EVENTIngest batch of events. Organization Access Token permissions: events:write.

Input Parameters

object
required
Request payload matching the exact Polar EventsIngest schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_BENEFIT_FILESList the downloadable files for a benefit with their download statistics. Organization Access Token permissions: benefits:read or benefits:write.

Input Parameters

string
required
id used by this operation.
integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_BENEFIT_GRANTSList benefit grants across all benefits accessible to the authenticated subject. Organization Access Token permissions: benefits:read or benefits:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
boolean
Filter by granted status. If true, only granted benefits will be returned. If false, only revoked benefits will be returned.
string
Filter by customer ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.
string
Filter by customer external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_BENEFIT_GRANTS_BY_BENEFITList the individual grants for a benefit. Organization Access Token permissions: benefits:read or benefits:write.

Input Parameters

string
required
id used by this operation.
integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by member.
boolean
Filter by granted status. If true, only granted benefits will be returned. If false, only revoked benefits will be returned.
string
Filter by customer.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_BENEFITSList benefits. Organization Access Token permissions: benefits:read or benefits:write.

Input Parameters

string
Filter by benefit IDs.
integer
Page number, defaults to 1.
string
Filter by benefit type.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by description.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
object
Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
string
Exclude benefits with these IDs.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_CHECKOUTSList checkout sessions. Organization Access Token permissions: checkouts:read or checkouts:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by customer email.
string
Filter by checkout session status.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
string
Filter by product ID.
string
Filter by customer ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.
string
Filter by customer external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_CUSTOMER_MEMBERSList members of a customer by UUID without changing membership. Organization Access Token permissions: members:read or members:write.

Input Parameters

string
required
The customer ID.
integer
Page number, defaults to 1.
string ("owner" | "billing_manager" | "member")
Filter by member role.
integer
Size of a page, defaults to 10. Maximum is 100.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_CUSTOMER_MEMBERS_BY_EXTERNAL_IDList members of a uniquely identified external customer without changing membership. Organization Access Token permissions: members:read or members:write.

Input Parameters

integer
Page number, defaults to 1.
string ("owner" | "billing_manager" | "member")
Filter by member role.
integer
Size of a page, defaults to 10. Maximum is 100.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
string
required
The customer external ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_CUSTOMER_METERSList customer meters. Organization Access Token permissions: customer_meters:read.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
string
Filter by meter ID.
string
Filter by customer ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.
string
Filter by external customer ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_CUSTOMER_PAYMENT_METHODSGet saved payment methods of a customer. Organization Access Token permissions: customers:read or customers:write.

Input Parameters

string
required
The customer ID.
integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_CUSTOMER_PAYMENT_METHODS_BY_EXTERNAL_IDGet saved payment methods of a customer by external ID. Organization Access Token permissions: customers:read or customers:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
required
The customer external ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_CUSTOMERSList customers. Organization Access Token permissions: customers:read or customers:write.

Input Parameters

integer
Page number, defaults to 1.
string
Filter by exact email.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by name, email, or external ID.
boolean
Filter by active customers, i.e. customers with at least one trialing, active or past_due subscription.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
object
Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_CUSTOMER_SEATSList customer seats for a subscription or order, including invitation and claim state.

Input Parameters

string
order_id used by this operation.
string
subscription_id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_CUSTOM_FIELDSList custom data fields configured for an organization and their validation settings.

Input Parameters

integer
Page number, defaults to 1.
string
Filter by custom field type.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by custom field name or slug.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_DISCOUNTSList discounts. Organization Access Token permissions: discounts:read or discounts:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by name.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_DISPUTESList payment disputes. Organization Access Token permissions: disputes:read or disputes:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by dispute status.
array
Sorting criteria applied in order. Prefix a criterion with - for descending order.
string
Filter by order ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_EVENT_NAMESList event names. Organization Access Token permissions: events:read or events:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Query to filter event names.
string
Filter by event source.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
string
Filter by customer ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.
string
Filter by external customer ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_EVENTSList events. Organization Access Token permissions: events:read or events:write.

Input Parameters

string
Filter by event name.
integer
Page number, defaults to 1.
integer
Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Query to filter events.
string
Filter events following filter clauses. JSON string following the same schema a meter filter clause.
string
Filter by event source.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
object
Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
string
Filter by a meter filter clause.
string
When combined with depth, use this event as the anchor instead of root events.
string
Filter by customer ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter events before this timestamp.
string
Filter by organization ID.
string
Filter events after this timestamp.
string
Filter by external customer ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_EVENT_TYPESList event types with usage statistics. Organization Access Token permissions: events:read or events:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter event types by name or label.
string ("system" | "user")
Filter by event source.
array
Sorting criteria applied in order. Prefix a criterion with - for descending order.
string
Filter by a specific parent event ID.
string
Filter by customer ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
boolean
Return only event types with root events.
string
Filter by organization ID.
string
Filter by external customer ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_FILESList files. Organization Access Token permissions: files:read or files:write.

Input Parameters

string
Filter by file ID.
integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_LICENSE_KEYSGet 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

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by license key status.
string
Filter by benefit ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_METERSList meters. Organization Access Token permissions: meters:read or meters:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by name.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
object
Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
boolean
Filter on archived meters.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_METRIC_DASHBOARDSList user-defined metric dashboards. Organization Access Token permissions: metrics:read.

Input Parameters

string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_ORDERSList orders. Organization Access Token permissions: orders:read.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by order status.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
object
Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
string
Filter by product ID.
string
Filter by checkout ID.
string
Filter by customer ID.
string
Filter by discount ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Only include orders created after this date
string
Only include orders created before this date
string
Filter by organization ID.
string
Filter by subscription ID.
string
Filter by customer external ID.
string
Filter by product billing type. recurring will filter data corresponding to subscriptions creations or renewals. one_time will filter data corresponding to one-time purchases.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_ORGANIZATIONSList organizations. Organization Access Token permissions: organizations:read or organizations:write.

Input Parameters

integer
Page number, defaults to 1.
string
Filter by slug.
integer
Size of a page, defaults to 10. Maximum is 100.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_PAYMENTSList payments. Organization Access Token permissions: payments:read.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by payment method.
string
Filter by payment status.
array
Sorting criteria applied in order. Prefix a criterion with - for descending order.
string
Filter by order ID.
string
Filter by checkout ID.
string
Filter by customer ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by customer email.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_PRODUCTSList products. Organization Access Token permissions: products:read or products:write.

Input Parameters

string
Filter by product ID.
integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Filter by product name.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
object
Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
string
Filter products granting specific benefit.
array
Filter by visibility.
boolean
Filter on archived products.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
boolean
Filter on recurring products. If true, only subscriptions tiers are returned. If false, only one-time purchase products are returned.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_REFUNDSList refunds. Organization Access Token permissions: refunds:read or refunds:write.

Input Parameters

string
Filter by refund ID.
integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
string
Filter by order ID.
boolean
Filter by succeeded.
string
Filter by customer ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.
string
Filter by subscription ID.
string
Filter by customer external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_SUBSCRIPTIONSList subscriptions. Organization Access Token permissions: subscriptions:read or subscriptions:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
boolean
Filter by active or inactive subscription.
string
Filter by subscription status.
array
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
object
Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
string
Filter by product ID.
string
Filter by customer ID.
string
Filter by discount ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Only include subscriptions started after this date.
string
Only include subscriptions started before this date.
string
Filter by organization ID.
string
Filter by cancellation date (after or equal to).
string
Filter by cancellation date (before or equal to).
boolean
Filter by subscriptions that are set to cancel at period end.
string
Filter by customer external ID.
string
Filter by customer cancellation reason.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_WEBHOOK_DELIVERIESList webhook deliveries. Organization Access Token permissions: webhooks:read or webhooks:write.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Query to filter webhook deliveries.
boolean
Filter by delivery success status.
string
Filter by webhook event type.
string
Filter by webhook endpoint ID.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter deliveries before this timestamp.
string ("2xx" | "3xx" | "4xx" | "5xx")
Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx).
string
Filter deliveries after this timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_LIST_WEBHOOK_ENDPOINTSList webhook endpoints with pagination; Organization Access Token permissions are webhooks:read or webhooks:write. The response contains sensitive webhook signing secrets; never log or persist it.

Input Parameters

integer
Page number, defaults to 1.
integer
Size of a page, defaults to 10. Maximum is 100.
string
Opaque continuation cursor returned by the previous call. When set, it controls the provider page value.
string
Filter by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_REDELIVER_WEBHOOK_EVENTSchedule 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

string
required
The webhook event ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_RESEND_CUSTOMER_SEAT_INVITATIONResend the invitation email for an unclaimed customer seat. This triggers an external email delivery and should not be retried automatically.

Input Parameters

string
required
seat_id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_REVOKE_CUSTOMER_SEATPermanently revoke a customer seat by ID. Verify the seat before removing access.

Input Parameters

string
required
seat_id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_REVOKE_SUBSCRIPTIONRevoke a subscription, i.e cancel immediately. This irreversibly revokes the subscription immediately. Organization Access Token permissions: subscriptions:write.

Input Parameters

string
required
The subscription ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_ROTATE_LICENSE_KEYRotate 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

string
required
id used by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_BENEFITUpdate a benefit. Organization Access Token permissions: benefits:write.

Input Parameters

string
required
id used by this operation.
string
required
Request payload matching the exact Polar Benefit Update schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_CHECKOUTUpdate a checkout session. Organization Access Token permissions: checkouts:write.

Input Parameters

string
required
The checkout session ID.
object
required
Request payload matching the exact Polar CheckoutUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_CHECKOUT_BY_CLIENT_SECRETUpdate a checkout session by client secret.

Input Parameters

object
required
Request payload matching the exact Polar CheckoutUpdatePublic schema.
string
required
The checkout session client secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_CUSTOMERUpdate a customer. Organization Access Token permissions: customers:write.

Input Parameters

string
required
The customer ID.
object
required
Request payload matching the exact Polar CustomerUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_CUSTOMER_BY_EXTERNAL_IDUpdate a customer by external ID. Organization Access Token permissions: customers:write.

Input Parameters

object
required
Request payload matching the exact Polar CustomerUpdateExternalID schema.
string
required
The customer external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_CUSTOMER_MEMBERUpdate 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

string
required
The customer ID.
object
required
Member fields to update.
string
required
The member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_CUSTOMER_MEMBER_BY_EXTERNAL_IDUpdate 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

object
required
Member fields to update.
string
required
The customer external ID.
string
required
The member external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_CUSTOM_FIELDUpdate an organization custom field’s label, validation, or data-collection settings.

Input Parameters

string
required
The custom field ID.
string
required
Request payload matching the exact Polar CustomFieldUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_DISCOUNTUpdate a discount. Organization Access Token permissions: discounts:write.

Input Parameters

string
required
The discount ID.
object
required
Request payload matching the exact Polar DiscountUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_EVENT_TYPEUpdate an event type’s label and optionally its dynamic label selector. Organization Access Token permissions: events:write.

Input Parameters

string
required
The event type ID.
object
required
Request payload matching Polar’s EventTypeUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_FILEUpdate a file’s name or version. Organization Access Token permissions: files:write.

Input Parameters

string
required
The file ID.
object
required
Request payload matching the exact Polar FilePatch schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_LICENSE_KEYUpdate 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

string
required
id used by this operation.
integer
Current license key usage count.
string ("granted" | "revoked" | "disabled")
New license key status.
string
Expiration timestamp, or null for no expiration.
integer
Maximum usage count, or null for no usage limit.
integer
Maximum number of activations, or null for no activation limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_METERUpdate a meter. Organization Access Token permissions: meters:write.

Input Parameters

string
required
The meter ID.
object
required
Request payload matching the exact Polar MeterUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_METRIC_DASHBOARDUpdate a user-defined metric dashboard. Organization Access Token permissions: metrics:write.

Input Parameters

string
required
The metric dashboard ID.
object
required
Request payload matching the exact Polar MetricDashboardUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_ORDERUpdate an order’s billing name or billing address; country and state cannot be updated. Organization Access Token permissions: orders:write.

Input Parameters

string
required
The order ID.
object
required
Request payload matching the exact Polar OrderUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_ORGANIZATIONUpdate an organization. Organization Access Token permissions: organizations:write.

Input Parameters

string
required
id used by this operation.
object
required
Request payload matching the exact Polar OrganizationUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_PRODUCTUpdate a product. Organization Access Token permissions: products:write.

Input Parameters

string
required
id used by this operation.
object
required
Request payload matching the exact Polar ProductUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_PRODUCT_BENEFITSUpdate benefits granted by a product. Organization Access Token permissions: products:write.

Input Parameters

string
required
id used by this operation.
object
required
Request payload matching the exact Polar ProductBenefitsUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_SUBSCRIPTIONUpdate a subscription. Organization Access Token permissions: subscriptions:write.

Input Parameters

string
required
The subscription ID.
string
required
Request payload matching the exact Polar SubscriptionUpdate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_UPDATE_WEBHOOK_ENDPOINTUpdate a webhook endpoint. The request or response contains sensitive credential material; never log or persist it. Organization Access Token permissions: webhooks:write.

Input Parameters

string
required
The webhook endpoint ID.
string
Destination URL where Polar sends webhook events.
string
An optional name for the webhook endpoint to help organize and identify it.
array
Event types that trigger this webhook endpoint.
string ("raw" | "discord" | "slack")
Webhook payload format.
boolean
Whether the webhook endpoint is enabled.
string ("2026-04" | "2026-10")
The API version that’ll be used in event payloads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_VALIDATE_LICENSE_KEYValidate 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

string
required
Sensitive license key value.
string
Benefit ID the license key must belong to.
object
Key-value object allowing you to set conditions that must match when validating the license key. The key must be a string with a maximum length of 40 characters. The value must be either: * A string with a maximum length of 500 characters * An integer * A floating-point number * A boolean You can store up to 50 key-value pairs.
string
Customer ID the license key must belong to.
string
License key activation ID.
integer
Non-negative amount to add to the license key usage count.
string
required
Polar organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POLAR_VALIDATE_LICENSE_KEY_PUBLICValidate a license key and optionally increment its usage count.

Input Parameters

object
required
Request payload matching the exact Polar LicenseKeyValidate schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not