Polar

List benefit grants across all benefits accessible to the authenticated subject. **Scopes**: `benefits:read` `benefits:write`

Create a benefit. **Scopes**: `benefits:write`

Delete a benefit. > [!WARNING] > Every grants associated with the benefit will be revoked. > Users will lose access to the benefit. **Scopes**: `benefits:write`

Get a benefit by ID. **Scopes**: `benefits:read` `benefits:write`

List the individual grants for a benefit. It's especially useful to check if a user has been granted a benefit. **Scopes**: `benefits:read` `benefits:write`

List benefits. **Scopes**: `benefits:read` `benefits:write`

Update a benefit. **Scopes**: `benefits:write`

Create a checkout link. **Scopes**: `checkout_links:write`

Delete a checkout link. **Scopes**: `checkout_links:write`

Get a checkout link by ID. **Scopes**: `checkout_links:read` `checkout_links:write`

List checkout links. **Scopes**: `checkout_links:read` `checkout_links:write`

Update a checkout link. **Scopes**: `checkout_links:write`

Create a checkout session. **Scopes**: `checkouts:write`

Get a checkout session by ID. **Scopes**: `checkouts:read` `checkouts:write`

List checkout sessions. **Scopes**: `checkouts:read` `checkouts:write`

Update a checkout session. **Scopes**: `checkouts:write`

Create a custom field. **Scopes**: `custom_fields:write`

Delete a custom field. **Scopes**: `custom_fields:write`

Get a custom field by ID. **Scopes**: `custom_fields:read` `custom_fields:write`

List custom fields. **Scopes**: `custom_fields:read` `custom_fields:write`

Update a custom field. **Scopes**: `custom_fields:write`

Get a customer meter by ID. **Scopes**: `customer_meters:read`

List customer meters. **Scopes**: `customer_meters:read`

Get a benefit grant by ID for the authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write`

List benefits grants of the authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write`

Update a benefit grant for the authenticated customer. **Scopes**: `customer_portal:write`

Get a meter by ID for the authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write`

List meters of the authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write`

Get information about the currently authenticated portal user. **Scopes**: `customer_portal:read` `customer_portal:write`

Introspect the current session and return its information. **Scopes**: `customer_portal:read` `customer_portal:write`

Add a payment method to the authenticated customer.

Check if an email change verification token is still valid.

Confirm a payment method for the authenticated customer.

Delete a payment method from the authenticated customer.

Get authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write`

Get saved payment methods of the authenticated customer.

Request an email change for the authenticated customer.

Update authenticated customer.

Verify an email change using the token from the verification email.

**Scopes**: `customer_portal:read` `customer_portal:write`

Activate a license key instance. > This endpoint doesn't require authentication and can be safely used on a public > client, like a desktop application or a mobile app. > If you plan to validate a license key on a server, use the `/v1/license-keys/activate` > endpoint instead.

Deactivate a license key instance. > This endpoint doesn't require authentication and can be safely used on a public > client, like a desktop application or a mobile app. > If you plan to validate a license key on a server, use the `/v1/license-keys/deactivate` > endpoint instead.

Get a license key. **Scopes**: `customer_portal:read` `customer_portal:write`

**Scopes**: `customer_portal:read` `customer_portal:write`

Validate a license key. > This endpoint doesn't require authentication and can be safely used on a public > client, like a desktop application or a mobile app. > If you plan to validate a license key on a server, use the `/v1/license-keys/validate` > endpoint instead.

Add a new member to the customer's team. Only available to owners and billing managers of team customers. Rules: - Cannot add a member with the owner role (there must be exactly one owner) - If a member with this email already exists, the existing member is returned

List all members of the customer's team. Only available to owners and billing managers of team customers.

Remove a member from the team. Only available to owners and billing managers of team customers. Rules: - Cannot remove yourself - Cannot remove the only owner

Update a member's name or role. Only available to owners and billing managers of team customers. Rules: - Cannot modify your own role (to prevent self-demotion) - Customer must have exactly one owner at all times

Confirm a retry payment using a Stripe confirmation token.

Trigger generation of an order's invoice.

Get an order by ID for the authenticated customer.

Get the current payment status for an order.

Get an order's invoice data.

List orders of the authenticated customer.

Get a presigned URL to download an order's receipt PDF.

Update an order for the authenticated customer.

Get a customer portal's organization by slug.

Assign Seat

List all subscriptions where the authenticated customer has claimed a seat. **Scopes**: `customer_portal:read` `customer_portal:write`

**Scopes**: `customer_portal:read` `customer_portal:write`

Resend Invitation

Revoke Seat

Cancel a subscription of the authenticated customer.

Get a subscription for the authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write`

List subscriptions of the authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write`

Update a subscription of the authenticated customer.

Get a wallet by ID for the authenticated customer.

List wallets of the authenticated customer.

**Scopes**: `customer_seats:write`

Claim Seat

Get Claim Info

**Scopes**: `customer_seats:read`

**Scopes**: `customer_seats:write`

**Scopes**: `customer_seats:write`

Create a customer session. For organizations with `member_model_enabled`, this will automatically create a member session for the owner member of the customer. **Scopes**: `customer_sessions:write`

Create a customer. **Scopes**: `customers:write`

Delete a customer. This action cannot be undone and will immediately: - Cancel any active subscriptions for the customer - Revoke all their benefits - Clear any `external_id` Use it only in the context of deleting a user within your own service. Otherwise, use more granular API endpoints to cancel a specific subscription or revoke certain benefits. Note: The customers information will nonetheless be retained for historic orders and subscriptions. Set `anonymize=true` to also anonymize PII for GDPR compliance. **Scopes**: `customers:write`

Delete a customer by external ID. Immediately cancels any active subscriptions and revokes any active benefits. Set `anonymize=true` to also anonymize PII for GDPR compliance. **Scopes**: `customers:write`

Export customers as a CSV file. **Scopes**: `customers:read` `customers:write`

Get a customer by ID. **Scopes**: `customers:read` `customers:write`

Get a customer by external ID. **Scopes**: `customers:read` `customers:write`

Get a customer state by ID. The customer state includes information about the customer's active subscriptions and benefits. It's the ideal endpoint to use when you need to get a full overview of a customer's status. **Scopes**: `customers:read` `customers:write`

Get a customer state by external ID. The customer state includes information about the customer's active subscriptions and benefits. It's the ideal endpoint to use when you need to get a full overview of a customer's status. **Scopes**: `customers:read` `customers:write`

List customers. **Scopes**: `customers:read` `customers:write`

Get saved payment methods of a customer. **Scopes**: `customers:read` `customers:write`

Get saved payment methods of a customer by external ID. **Scopes**: `customers:read` `customers:write`

Create a new member for a customer. Only B2B customers with the member management feature enabled can add members. The authenticated user or organization must have access to the customer's organization. **Scopes**: `members:write`

Create a new member for a customer identified by its external ID. **Scopes**: `members:write`

Delete a member of a customer. **Scopes**: `members:write`

Delete a member by external ID for a customer identified by its external ID. **Scopes**: `members:write`

Get a member of a customer by its ID. **Scopes**: `members:read` `members:write`

Get a member by external ID for a customer identified by its external ID. **Scopes**: `members:read` `members:write`

Update a member of a customer. Only name, email and role can be updated. **Scopes**: `members:write`

Update a member by external ID for a customer identified by its external ID. **Scopes**: `members:write`

Update a customer. **Scopes**: `customers:write`

Update a customer by external ID. **Scopes**: `customers:write`

Create a discount. **Scopes**: `discounts:write`

Delete a discount. **Scopes**: `discounts:write`

Get a discount by ID. **Scopes**: `discounts:read` `discounts:write`

List discounts. **Scopes**: `discounts:read` `discounts:write`

Update a discount. **Scopes**: `discounts:write`

Accept a dispute, conceding the chargeback. Closes the dispute with the processor (settling it as `lost`) and records the merchant's decision on the dispute's support case. **Scopes**: `disputes:write`

Get a dispute by ID. **Scopes**: `disputes:read` `disputes:write`

List disputes. **Scopes**: `disputes:read` `disputes:write`

List event types with aggregated statistics. **Scopes**: `events:read` `events:write`

Update an event type's label. **Scopes**: `events:write`

Get an event by ID. **Scopes**: `events:read` `events:write`

Ingest batch of events. **Scopes**: `events:write`

List events. **Scopes**: `events:read` `events:write`

List event names. **Scopes**: `events:read` `events:write`

Create a file. **Scopes**: `files:write`

Delete a file. **Scopes**: `files:write`

List files. **Scopes**: `files:read` `files:write`

Update a file. **Scopes**: `files:write`

Complete a file upload. **Scopes**: `files:write`

Activate a license key instance. **Scopes**: `license_keys:write`

Deactivate a license key instance. **Scopes**: `license_keys:write`

Get a license key. **Scopes**: `license_keys:read` `license_keys:write`

Get a license key activation. **Scopes**: `license_keys:read` `license_keys:write`

Get license keys connected to the given organization & filters. **Scopes**: `license_keys:read` `license_keys:write`

Update a license key. **Scopes**: `license_keys:write`

Validate a license key. **Scopes**: `license_keys:write`

List members with optional customer ID filter. **Scopes**: `members:read` `members:write`

Create a meter. **Scopes**: `meters:write`

Get a meter by ID. **Scopes**: `meters:read` `meters:write`

List meters. **Scopes**: `meters:read` `meters:write`

Get quantities of a meter over a time period. **Scopes**: `meters:read` `meters:write`

Update a meter. **Scopes**: `meters:write`

Create a user-defined metric dashboard. **Scopes**: `metrics:write`

Delete a user-defined metric dashboard. **Scopes**: `metrics:write`

Export metrics as a CSV file. **Scopes**: `metrics:read`

Get metrics about your orders and subscriptions. Currency values are output in cents. **Scopes**: `metrics:read`

Get a user-defined metric dashboard by ID. **Scopes**: `metrics:read`

Get the interval limits for the metrics endpoint. **Scopes**: `metrics:read`

List user-defined metric dashboards. **Scopes**: `metrics:read`

Update a user-defined metric dashboard. **Scopes**: `metrics:write`

Get information about the authenticated user.

Create a draft order for an off-session charge against a saved payment method. The order is created with `status=draft` and no invoice number; call `POST /v1/orders/{id}/finalize` to attempt the charge. The organization must have the `off_session_charges_enabled` feature flag. **Scopes**: `orders:write`

Export orders as a CSV file. **Scopes**: `orders:read`

Finalize a draft order and synchronously attempt an off-session charge. On success, the order transitions to `paid` and benefit grants fire before the response returns. On failure (decline, missing payment method, SCA challenge), the order stays in `draft` and a 4xx error is returned. The request fails with 412 if the order is not in `draft` status. **Scopes**: `orders:write`

Trigger generation of an order's invoice. **Scopes**: `orders:read`

Get an order by ID. **Scopes**: `orders:read`

Get an order's invoice data. **Scopes**: `orders:read`

List orders. **Scopes**: `orders:read`

Get a presigned URL to download an order's receipt PDF. **Scopes**: `orders:read`

Update an order. **Scopes**: `orders:write`

Create an organization. **Scopes**: `organizations:write`

Get an organization by ID. **Scopes**: `organizations:read` `organizations:write`

List organizations. **Scopes**: `organizations:read` `organizations:write`

Update an organization. **Scopes**: `organizations:write`

Get a payment by ID. **Scopes**: `payments:read`

List payments. **Scopes**: `payments:read`

Create a product. **Scopes**: `products:write`

Get a product by ID. **Scopes**: `products:read` `products:write`

List products. **Scopes**: `products:read` `products:write`

Update a product. **Scopes**: `products:write`

Update benefits granted by a product. **Scopes**: `products:write`

Create a refund. **Scopes**: `refunds:write`

List refunds. **Scopes**: `refunds:read` `refunds:write`

Create a subscription programmatically. This endpoint only allows to create subscription on free products. For paid products, use the checkout flow. No initial order will be created and no confirmation email will be sent. **Scopes**: `subscriptions:write`

Export subscriptions as a CSV file. **Scopes**: `subscriptions:read` `subscriptions:write`

Get a subscription by ID. **Scopes**: `subscriptions:read` `subscriptions:write`

List subscriptions. **Scopes**: `subscriptions:read` `subscriptions:write`

Revoke a subscription, i.e cancel immediately. **Scopes**: `subscriptions:write`

Update a subscription. **Scopes**: `subscriptions:write`

Create a webhook endpoint. **Scopes**: `webhooks:write`

Delete a webhook endpoint. **Scopes**: `webhooks:write`

Get a webhook endpoint by ID. **Scopes**: `webhooks:read` `webhooks:write`

List webhook deliveries. Deliveries are all the attempts to deliver a webhook event to an endpoint. **Scopes**: `webhooks:read` `webhooks:write`

List webhook endpoints. **Scopes**: `webhooks:read` `webhooks:write`

Schedule the re-delivery of a webhook event. **Scopes**: `webhooks:write`

Regenerate a webhook endpoint secret. **Scopes**: `webhooks:write`

Update a webhook endpoint. **Scopes**: `webhooks:write`