# Polar > ## Documentation Index --- # Source: https://polar.sh/docs/merchant-of-record/acceptable-use.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # null As your Merchant of Record (MoR), we are the reseller of all digital goods and services and focus exclusively on digital products. Therefore we cannot support physical goods or entirely human services, e.g consultation or support. In addition to not accepting the sale of anything illegal, harmful, abusive, deceptive or sketchy. ## Acceptable Products & Businesses * Software & SaaS * Digital products: Templates, eBooks, PDFs, code, icons, fonts, design assets, photos, videos, audio etc * Premium content & access: Discord server, GitHub repositories, courses and content requiring a subscription. **General rule of acceptable services** Digital goods, software or services that can be fulfilled by… 1. Polar on your behalf (License Keys, File Downloads, GitHub- or Discord invites or private links, e.g premium YouTube videos etc) 2. Your site/service using our APIs to grant immediate access to digital assets or services for customers with a one-time purchase or subscriptions Combined with being something you’d proudly boast about in public, i.e nothing illegal, unfair, deceptive, abusive, harmful or shady. Don’t hesitate to [reach out to us](/support) in advance in case you’re unsure if your use case would be approved. ## Prohibited Businesses **Not an exhaustive list** We reserve the right to add to it at any time. Combined with placing your account under further review or suspend it in case we consider the usage deceptive, fraudulent, high-risk or of low quality for consumers with high refund/chargeback risks. * Illegal or age restricted, e.g drugs, alcohol, tobacco or vaping products * Violates laws in the jurisdictions where your business is located or to which your business is targeted * Violates any rules or regulations from payment processors & credit card networks, e.g [Stripe](https://stripe.com/en-se/legal/restricted-businesses) * Reselling or distributing customer data to other parties for commercial, promotional or any other reason (disclosed service providers are accepted). * Threatens reputation of Polar or any of our partners and payment providers * Causes or has a significant risk of refunds, chargebacks, fines, damages, or harm and liability * Services used by-, intended for or advertised towards minors * Physical goods of any kind. Including SaaS services offering or requiring fulfilment via physical delivery or human services. * Human services, e.g marketing, design, web development and consulting in general. * Donations or charity, i.e price is greater than product value or there is no exchange at all (pure money transfer). Open source maintainers with sponsorship can be supported - reach out. * Marketplaces. Selling others’ products or services using Polar against an upfront payment or with an agreed upon revenue share. * Adult services or content. Including by AI or proxy, e.g * AI Girlfriend/Boyfriend services. * OnlyFans related services. * Explicit/NSFW content generated with AI * Low-quality products, services or sites, e.g * E-books generated with AI or 4 pages sold for \$50 * Quickly & poorly executed websites, products or services * Services with a lot of bugs and issues * Products, services or websites we determine to have a low trust score * Fake testimonials, reviews, social proof, and review inflation platforms. It's deceptive to consumers which is behaviour we do not tolerate. * Trademark violations * "Get rich" schemes or content * Gambling & betting services (including lootboxes, mystery boxes and pack openings of random nature) * Regulated services or products * Counterfeit goods * Job boards * NFT & Crypto assets. * Cheating: Utilizing macros, cheat codes, hacks, or any unauthorized modifications that alter gameplay or provide an unfair advantage. * Reselling Licenses: Selling, distributing, or otherwise transferring software licenses at reduced prices or without proper authorization. * Services to circumvent rules or terms of other services: Attempting to bypass, manipulate, or undermine any established rules, gameplay mechanics, or pricing structures of other vendors/games. * Financial services, e.g facilitating transactions, investments or balances for customers. * Financial trading, trading bots, brokerage, or investment advisory services (including insights platforms). * Financial advice, e.g content or services related to tax guidance, wealth management, trading signals, investment strategies etc. * IPTV services * Virus & Spyware * Telecommunication & eSIM Services * Products you don’t own the IP of or have the required licenses to resell * Advertising & unsolicited marketing services. Including services to: * Generate, scrape or sell leads * Send SMS/WhatsApp messages in bulk * Automate outreach (spam risks) * Automate mass content generation & submission across sites * API & IP cloaking services, e.g services to circumvent IP bans, API rate limits etc. * Products or services associated with pseudo-science; clairvoyance, horoscopes, fortune-telling etc. * Travel services, reservation services, travel clubs and timeshares * Medical advice services or products, e.g. pharmaceutical, weight loss, muscle building * Watermark removal services * Third-party content downloaders (e.g., YouTube, Instagram, Snapchat, etc.) ## Restricted Businesses Requires closer review and a higher bar of quality, execution, trust and compliance standards to be accepted. * Directories & boards * Marketing services * Pre-orders & Paid waitlist * Ticket sales * eBooks ## FAQ **Why do directories & boards require closer review?** They often sell premium placement, i.e ads, without meeting compliance requirements for advertising. Or even where it's their sole purpose to sell placement. **Why do marketing services require closer review?** Too many services offer sketchy marketing tactics and mass outreach (unsolicited) features. There is no short-cut to sales beyond offering a great product & service. We love marketing services that reflect that and focus on the long game vs. shortcuts and hacks. **Can I sell pre-orders or use paid waitlists for my service to validate demand before build?** Generally, no. It's a high risk category for us as the Merchant of Record. Sellers could withdraw funds and never deliver the service or not as promised. Causing consumers to demand refunds or dispute the sale against us at a later date. For high-trust cases from developers with a track record, we're able to make exceptions, but simultaneously need to adapt our payout process to withhold all funds until verified fulfilment. **Why are marketplaces or human services (consultancy) not allowed?** We hope to change this status quo amongst Merchants of Record long-term, but both come with additional compliance and risk challenges. Since fulfilment is not digital, immediate or between known parties to us, we cannot fulfil our compliance & risk requirements or effectively mitigate potential disputes. **Why are OnlyFans services not allowed?** Close & blurred lines between the service and the content & service provided on OnlyFans, i.e often adult content. In addition to us having seen fraudulent & deceptive behavior in the category. We're simply not comfortable acting as the Merchant of Record here. --- # Source: https://polar.sh/docs/merchant-of-record/account-reviews.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # null As a Merchant of Record (MoR), we act as the reseller of digital goods and services. Therefore, we need to make sure that businesses using Polar complies with our [acceptable products & use](/merchant-of-record/acceptable-use) policies. Combined with continuously monitoring, reviewing and preventing fraud, unacceptable use, bad actors and high risk accounts. Account reviews are typically completed within a week on average. However, sometimes it can take longer due to weekends, holidays etc. We process them as quickly as possible and resolve every single one. ### First payout review You will need to go through our main review ahead of the initial payout. We’ll reach out over email for: 1. A quick survey about your business, products and intended use case with Polar. 2. Identity verification (KYC) using Passport/ID Card/Driver License and a selfie. It’s secure, easy and quick to submit using Stripe Identity. We need to perform this review to ensure compliance with our [acceptable products & use](/merchant-of-record/acceptable-use) policy. Combined with meeting our own KYC/AML requirements as a billing platform. **Submit upfront (Soon)** We’ll soon offer the ability to submit all of this information in advance to speed up the initial payout even further and without concern of any issues or delays. ### Continuous reviews (Async) We continuously monitor all transactions across our platform to proactively prevent fraud. In addition to performing asynchronous reviews of accounts at certain sale thresholds. These reviews are often completed within a day or two and without any additional information required from you. You’ll get notified over email that a review is taking place. Payouts will be paused during this time, but it has no impact on your customers’ experience or ability to purchase, subscribe or checkout at any time. We look at: * Risk scores across historic transactions * Refunds & Chargebacks ratio * Appropriate next sales threshold for a review given the above **High chargeback ratios** Credit card networks, e.g Visa/Mastercard, consider 0.7% of sales in chargebacks excessive. Exceeding it can lead to monitoring programs with high costs, penalties and ultimately termination. We therefore reach out proactively to collaborate on maintaining a low chargeback ratio and reducing it ahead of getting close to these thresholds. ## Operational Guidelines To maintain platform integrity and ensure smooth operations, we have established clear guidelines for merchants using Polar. #### Expected Responsiveness We expect merchants to maintain high standards of customer support and responsiveness to their customers: * **Support Ticket Management**: Maintain a low rate of support tickets from customers * **Merchant Communication**: When we include you in customer support communications, we require a response within 48 hours * If no response is received within 48 hours, we may issue refunds to affected customers and a warning to merchants * In case of repeated issues, we'll have to offboard unresponsive merchants * **Customer Service Quality**: We evaluate your customer service history and approach when determining appropriate actions #### Test Transactions To maintain platform security and prevent abuse: * **Use Sandbox Environment or 100% Discounts**: All testing must be conducted using our sandbox environment. Want to test in production? Use a Free Product or a 100% Discount code to avoid using real money. * **No Real Money Testing**: Any such transactions are prohibited and will be refunded. It's against the terms of payment service providers, triggers our account reviews and can potentially lead to the card or account getting blocked since it can be flagged as "card testing". #### Chargeback Management We monitor chargeback rates closely to protect both merchants and customers: * **Acceptable Threshold**: We maintain a chargeback rate threshold of 0.4% for merchants * **Timeframe**: Chargebacks can be filed up to 120 days from the original transaction date * **Consequences of High Chargeback Rates**: We work proactively to maintain a low chargeback rate throughout the platform and strive to collaborate with merchants at risk of exceeding our thresholds to reverse the trend. However, we reserve the right to (in order of severity): * Refund transactions as needed * Pause payouts pending review – up until the timeframe for chargebacks have been surpassed * Pause future payments * Block accounts and refund customers We don't take this responsibility or actions lightly, and always strive to mitigate and avoid them, but have to take appropriate and proactive actions in case of issues. We also have integrations with credit card networks to receive early chargeback signals before they're officially filed. We automatically refund such transactions under a certain value and cancel any subscriptions associated with the customer to reduce chargebacks proactively. #### Policy Violations For merchants who violate our [acceptable use policies](/merchant-of-record/acceptable-use) (and don't have high chargeback rates): * **Immediate Action**: We will offboard merchants who violate our policies * **Payment Processing**: All payment processing will be blocked * **Payout Management**: Payouts will be paused pending review * **Resolution Process**: * We may conduct test transactions to verify account status * In case of strong suspicion of fraud or intentional abuse, we block the account immediately * We reach out merchants about the issue and give them 48 hours to respond * Failure to respond may result in refunds to affected customers * We pause future payments in the meantime if deemed necessary * We pause payouts during the resolution process * We strive to collaborate with merchants on the best possible path forward. Clear fraud or abuse, however, is immediately blocked. * We have to cancel subscriptions and refund payments made in violation of our acceptable use policies for compliance and risk, and strive to do so in collaboration with the merchant. ## Frequently Asked Questions ### Why is my account under review again? Your account may go through multiple reviews as your business grows. We perform [continuous reviews](#continuous-reviews-async) at certain sales thresholds to maintain platform integrity and prevent fraud. This is a standard practice across payment platforms and is part of our ongoing risk management process. ### Why do you need my social media in settings? We request social media information as part of our identity verification and fraud prevention processes. This helps us: * Verify that you're a real business or creator with an online presence * Understand your products and services better * Ensure compliance with our [acceptable use policies](/merchant-of-record/acceptable-use) Providing accurate social media information helps speed up the review process and demonstrates the legitimacy of your business. ### Are social media settings visible publicly? No, your social media settings are not publicly visible. This information is used internally for verification and compliance purposes only. We treat all merchant information with strict confidentiality and use it solely for risk assessment and account review processes. ### Why do I need to share a video recording showing the product working? To help us verify that everything is working correctly in line with our acceptable use policy, our team would ask you to share a 100% discount code by email. This is our preferred method, as it allows the team to go through the full journey themselves and confirm the automated fulfillment from an unpaid user to a paid user. Alternatively, you can provide a video recording that clearly shows the complete flow from an unpaid user to a paid user, including how the product is automatically accessible after purchase. ### How does changing the admin of an organization work? To change the admin of an organization: 1. Invite the new admin to the team via `Settings` > `Members` in the Polar dashboard 2. Ask that new admin to complete identity verification under `Finance` > `Account` after logging in via that email in the Polar dashboard 3. Make sure no payout is pending 4. Send an email from the current admin email to our support confirming the transfer to the new admin If you need assistance with changing organization ownership or have special circumstances, please contact [support@polar.sh](mailto:support@polar.sh). --- # Source: https://polar.sh/docs/features/finance/accounts.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Setup a Payout Account ## Connect Payout Account You need to setup an account so that we can issue [payouts](/features/finance/payouts).

1. Go to the `Finance` page in your Polar dashboard 2. Click `Setup` in the card shown above in your dashboard 3. Choose account type & follow their setup instructions *This is only required the first time and you can do this proactively too in order - recommended to avoid any additional delays.* ### Stripe Connect Express

Stripe is the default and recommended option since it enables instant transfers. --- # Source: https://polar.sh/docs/api-reference/license-keys/activate.md # Source: https://polar.sh/docs/api-reference/customer-portal/license-keys/activate.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Activate License Key > 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. You only need to use this endpoint if you have device **activations** enabled on the license key benefit. You then use this endpoint to reserve an allocation for a specific device. Storing the unique activation ID from the response on the device and using it as extra validation in the [/validate](/api-reference/customer-portal/license-keys/validate) endpoint. Not using **activations**? Just use the [/validate](/api-reference/customer-portal/license-keys/validate) endpoint directly instead. ## OpenAPI ````yaml post /v1/customer-portal/license-keys/activate openapi: 3.1.0 info: title: Polar API summary: Polar HTTP and Webhooks API description: Read the docs at https://polar.sh/docs/api-reference version: 0.1.0 servers: - url: https://api.polar.sh description: Production environment x-speakeasy-server-id: production - url: https://sandbox-api.polar.sh description: Sandbox environment x-speakeasy-server-id: sandbox security: - access_token: [] tags: - name: public description: >- Endpoints shown and documented in the Polar API documentation and available in our SDKs. - name: private description: >- Endpoints that should appear in the schema only in development to generate our internal JS SDK. - name: mcp description: Endpoints enabled in the MCP server. paths: /v1/customer-portal/license-keys/activate: post: tags: - customer_portal - license_keys - public summary: Activate License Key description: >- 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. operationId: customer_portal:license_keys:activate requestBody: content: application/json: schema: $ref: '#/components/schemas/LicenseKeyActivate' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/LicenseKeyActivationRead' '403': description: >- License key activation not supported or limit reached. Use /validate endpoint for licenses without activations. content: application/json: schema: $ref: '#/components/schemas/NotPermitted' '404': description: License key not found. content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - {} components: schemas: LicenseKeyActivate: properties: key: type: string title: Key organization_id: type: string format: uuid4 title: Organization Id label: type: string title: Label conditions: additionalProperties: anyOf: - type: string maxLength: 500 minLength: 1 - type: integer - type: number - type: boolean propertyNames: maxLength: 40 minLength: 1 type: object maxProperties: 50 title: Conditions description: >- 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**. meta: additionalProperties: anyOf: - type: string maxLength: 500 minLength: 1 - type: integer - type: number - type: boolean propertyNames: maxLength: 40 minLength: 1 type: object maxProperties: 50 title: Meta description: >- 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**. type: object required: - key - organization_id - label title: LicenseKeyActivate LicenseKeyActivationRead: properties: id: type: string format: uuid4 title: Id license_key_id: type: string format: uuid4 title: License Key Id label: type: string title: Label meta: additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object title: Meta created_at: type: string format: date-time title: Created At modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At license_key: $ref: '#/components/schemas/LicenseKeyRead' type: object required: - id - license_key_id - label - meta - created_at - modified_at - license_key title: LicenseKeyActivationRead NotPermitted: properties: error: type: string const: NotPermitted title: Error examples: - NotPermitted detail: type: string title: Detail type: object required: - error - detail title: NotPermitted ResourceNotFound: properties: error: type: string const: ResourceNotFound title: Error examples: - ResourceNotFound detail: type: string title: Detail type: object required: - error - detail title: ResourceNotFound HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError LicenseKeyRead: properties: id: type: string format: uuid4 title: Id description: The ID of the object. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. organization_id: type: string format: uuid4 title: Organization Id customer_id: type: string format: uuid4 title: Customer Id customer: $ref: '#/components/schemas/LicenseKeyCustomer' benefit_id: type: string format: uuid4 title: Benefit Id description: The benefit ID. x-polar-selector-widget: displayProperty: description resourceName: Benefit resourceRoot: /v1/benefits key: type: string title: Key display_key: type: string title: Display Key status: $ref: '#/components/schemas/LicenseKeyStatus' limit_activations: anyOf: - type: integer - type: 'null' title: Limit Activations usage: type: integer title: Usage limit_usage: anyOf: - type: integer - type: 'null' title: Limit Usage validations: type: integer title: Validations last_validated_at: anyOf: - type: string format: date-time - type: 'null' title: Last Validated At expires_at: anyOf: - type: string format: date-time - type: 'null' title: Expires At type: object required: - id - created_at - modified_at - organization_id - customer_id - customer - benefit_id - key - display_key - status - limit_activations - usage - limit_usage - validations - last_validated_at - expires_at title: LicenseKeyRead ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError LicenseKeyCustomer: properties: id: type: string format: uuid4 title: Id description: The ID of the customer. examples: - 992fae2a-2a17-4b7a-8d9e-e287cf90131b created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' external_id: anyOf: - type: string - type: 'null' title: External Id description: >- The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated. examples: - usr_1337 email: type: string title: Email description: >- The email address of the customer. This must be unique within the organization. examples: - customer@example.com email_verified: type: boolean title: Email Verified description: >- Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address. examples: - true type: anyOf: - $ref: '#/components/schemas/CustomerType' - type: 'null' description: >- The type of customer: 'individual' for single users, 'team' for customers with multiple members. Legacy customers may have NULL type which is treated as 'individual'. examples: - individual name: anyOf: - type: string - type: 'null' title: Name description: The name of the customer. examples: - John Doe billing_address: anyOf: - $ref: '#/components/schemas/Address' - type: 'null' tax_id: anyOf: - prefixItems: - type: string - $ref: '#/components/schemas/TaxIDFormat' type: array maxItems: 2 minItems: 2 examples: - - '911144442' - us_ein - - FR61954506077 - eu_vat - type: 'null' title: Tax Id organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the customer. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At description: Timestamp for when the customer was soft deleted. avatar_url: type: string title: Avatar Url examples: - https://www.gravatar.com/avatar/xxx?d=404 type: object required: - id - created_at - modified_at - metadata - external_id - email - email_verified - name - billing_address - tax_id - organization_id - deleted_at - avatar_url title: LicenseKeyCustomer LicenseKeyStatus: type: string enum: - granted - revoked - disabled title: LicenseKeyStatus MetadataOutputType: additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object CustomerType: type: string enum: - individual - team title: CustomerType Address: properties: line1: anyOf: - type: string - type: 'null' title: Line1 line2: anyOf: - type: string - type: 'null' title: Line2 postal_code: anyOf: - type: string - type: 'null' title: Postal Code city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State country: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: CountryAlpha2 examples: - US - SE - FR x-speakeasy-enums: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW type: object required: - country title: Address securitySchemes: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. ```` --- # Source: https://polar.sh/docs/features/integrations/affonso.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Affonso Affiliates with Polar This guide explains how to integrate [Affonso](https://affonso.io)'s affiliate marketing software with your Polar account to track and manage affiliate-driven sales for your SaaS business. ## What is Affonso? [Affonso](https://affonso.io) is an affiliate marketing software that enables SaaS businesses to launch, manage, and scale their own affiliate programs. With Affonso, you can: * Set up flexible commission structures * Manage multiple affiliate programs from one dashboard * Provide your affiliates with real-time tracking and marketing resources * Automate affiliate payments and commission calculations ## Integration Steps ### 1. Create a Polar Access Token for Affonso First, you'll need to create an API token in Polar that Affonso can use to communicate with your account: 1. Login to your **Polar Dashboard** 2. Navigate to **Settings** in the main menu 3. Scroll down to the **Developers** section on the Settings page 4. Click the **New token** button 5. Give your token a name (e.g., "Affonso Integration") 6. Set token expiration to **No expiration** Important: If you set an expiration date, you'll need to manually update the token in Affonso when it expires. Tracking will stop working if the token expires. 7. Enable all the following scopes: * discounts:read * discounts:write * events:read * subscriptions:read * customers:read * customers:write * orders:read * refunds:read * webhooks:read * webhooks:write 8. Click **Create token** and copy the generated token 9. Provide this token to Affonso by entering it [in their integration settings](https://affonso.io/app/affiliate-program/connect)

### 2. Set Up Webhooks in Polar After connecting your Polar account with Affonso, you'll [receive a webhook URL and secret from Affonso](https://affonso.io/app/affiliate-program/connect). Add these to your Polar account: 1. Go to **Settings** → **Developers** → **Webhooks** in your Polar Dashboard 2. Click the **"Add Endpoint"** button 3. In the URL field, paste the webhook URL provided by Affonso 4. For Format, select **RAW** from the dropdown 5. In the Secret field, paste the webhook secret provided by Affonso 6. Under Events, enable all of the following: * `order.created` * `order.refunded` * `subscription.canceled` 7. Click **Save** to complete the webhook setup

### 3. Add the Affonso Tracking Script to Your Website Add Affonso's tracking script to the `` tag of your website: ```html theme={null} ``` Replace `YOUR_AFFONSO_PROGRAM_ID` with the unique program ID provided by Affonso. This script should be placed on all pages of your website, including: * Your main marketing website * Your application domain * Any subdomains where users might land or make purchases ### 4. Track User Signups (Optional) For better conversion insights, you can track when users sign up through an affiliate link: ```javascript theme={null} // After successful registration window.Affonso.signup(userEmail); ``` ### 5. Pass Referral Data to Polar Checkout To ensure proper commission attribution, pass the referral data when creating checkout sessions: ```javascript theme={null} // Get the referral ID from the Affonso global variable const referralId = window.affonso_referral; // Create checkout session with Polar const checkout = await polar.checkouts.create({ products: ["your_product_id"], success_url: "https://your-app.com/success", metadata: { affonso_referral: referralId, // Include referral ID from Affonso } }); // Redirect to checkout window.location.href = checkout.url; ``` ## How It Works 1. When a user visits your site through an affiliate link, Affonso's script stores a unique identifier in a cookie 2. If you've implemented signup tracking, Affonso records when the user creates an account 3. When the user makes a purchase, the referral ID is passed to Polar as metadata 4. Polar's webhook notifies Affonso about the purchase 5. Affonso attributes the sale to the correct affiliate and calculates the commission ## Benefits of the Integration * **Automated Tracking**: No manual work required to track affiliate-driven sales * **Real-Time Analytics**: Both you and your affiliates get immediate insights into performance * **Seamless User Experience**: The integration works behind the scenes without affecting your checkout flow * **Flexible Commission Structures**: Set up complex commission rules based on product, subscription duration, etc. ## Getting Help More details about the integration: [Polar Affiliate Program](https://affonso.io/polar-affiliate-program) If you need assistance with your Affonso integration, contact Affonso's support team: * Email: [hello@affonso.io](mailto:hello@affonso.io) * Live chat: Available directly in the Affonso dashboard --- # Source: https://polar.sh/docs/guides/allow-multiple-subscriptions-per-customer.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # How to allow multiple subscriptions per customer > Learn how to allow multiple subscriptions per customer in Polar. In the Polar dashboard sidebar, click on **Settings**. You can also go directly to:\ `https://polar.sh/dashboard/${org_slug}/settings`\ Scroll down to **Subscriptions** section.

**Toggle ON** Allow multiple subscriptions to allow multiple subscriptions per customer.

Click **Save** in the **Subscriptions** section to save the changed settings.

--- # Source: https://polar.sh/docs/features/analytics.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Analytics ## Sales Metrics Polar offers a professional metrics dashboard out of the box. So you can stay focused on increasing revenue vs. how to measure it.

**Missing any metrics?** [Let us know so we can add it.](https://github.com/orgs/polarsource/discussions/categories/feature-requests) ### Filters You can easily slice and dice metrics with the filters below. ### Period Change the time period in the X-axis to one of: * Yearly * Monthly * Weekly * Daily * Hourly ### Timeframe You can choose a date range to view all metrics for. ### Product By default metrics reflect the total across all products. However, you can specify individual products or subscription tiers to filter metrics by. ## Metrics * **Revenue**: How much revenue you've earned before fees. * **Orders**: How many product sales and subscription payments have been made. * **Average Order Value (AOV)**: The average earning per order, i.e. revenue / orders. * **One-Time Products**: Amount of products sold. * **One-Time Products Revenue**: Amount of revenue earned from products. * **New Subscriptions**: Amount of new subscriptions. * **New Subscription Revenue**: Amount of revenue earned from new subscriptions. * **Renewed Subscriptions**: Amount of renewed subscriptions. * **Renewed Subscription Revenue**: Amount of revenue earned from renewed subscriptions. * **Active Subscriptions**: Amount of active subscriptions (new + renewed). * **Monthly Recurring Revenue (MRR)**: Amount of revenue earned from active subscriptions. * **Checkouts**: Number of created checkouts. * **Succeeded Checkouts**: Number of successful checkouts, i.e. checkouts that lead to a new order or subscription. * **Checkouts Conversion Rate**: The percentage of successful checkouts out of all created checkouts. ## Cost Metrics * **Costs**: How much costs you've incurred. * **Cumulative Costs**: How much costs you've incurred over time. * **Cost Per User**: The average cost per active user. * **Gross Margin**: The gross margin, i.e. revenue - costs. * **Gross Margin Percentage**: The gross margin percentage, i.e. gross margin / revenue. * **Net Cashflow**: The net cashflow, i.e. revenue - costs. * **Monthly Recurring Cost (MRC)**: The monthly recurring cost, i.e. costs / active subscriptions. * **Return on Investment (ROI)**: The return on investment, i.e. (revenue - costs) / costs. --- # Source: https://polar.sh/docs/changelog/api.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # API Changelog > Stay up to date with the latest changes, improvements and deprecations to the Polar API. ## Checkout API and Customer Session API changes To be more consistent across our API, we've renamed `customer_external_id` field to `external_customer_id` in the Checkout API and Customer Session API. * **Deprecated**: `customer_external_id` field in the Checkout API and Customer Session API. Use `external_customer_id` instead. ## Benefit metadata in Customer State The customer state now includes the [benefit metadata](/api-reference/customers/state#response-benefit-metadata) in the `granted_benefits` list. ## Webhook API endpoints are now documented The API endpoints for managing webhooks are now documented in the API reference, and fully supported in our SDK. [Read more](/api-reference/webhooks/endpoints/create) ## Rate limits To ensure fair usage and maintain performance, we've introduced rate limits for the API. The limits are as follows: * **100 requests per second** per IP address. ## Order invoice generation and retrieval Until now, the invoice was generated automatically when the order was created, allowing you to call [`GET /v1/orders/{id}/invoice`](/api-reference/orders/get-invoice) and [`GET /v1/customer-portal/orders/{id}/invoice`](/api-reference/customer-portal/orders/get-invoice) endpoints without any prior action. We now require you to explicitly generate the invoice by calling the [`POST /v1/orders/{id}/invoice`](/api-reference/orders/post-invoice) or [`POST /v1/customer-portal/orders/{id}/invoice`](/api-reference/customer-portal/orders/post-invoice) endpoints. This change allows us to better handle the invoice generation process, and to allow the customer to change the billing details (name and address) before generating the invoice. This can be done through the [`PATCH /v1/orders/{id}`](/api-reference/orders/patch) or [`PATCH /v1/customer-portal/orders/{id}`](/api-reference/customer-portal/orders/patch) endpoints. ## Benefit metadata support and floating point numbers in metadata * **Added**: Benefits now support [metadata](/api-reference/benefits/create#body-metadata). * **Added**: Metadata values now support floating-point numbers. Before, only strings, integers and booleans were supported. ## Checkout amount fields changes and depreciations To be more consistent with the [Order schema changes](#2025-03-14), we've made some changes to the field related to amounts in the Checkout schema. * **Added**: [`checkout.discount_amount`](/api-reference/checkouts/get-session#response-discount-amount). * **Added**: [`checkout.net_amount`](/api-reference/checkouts/get-session#response-net-amount). * **Deprecated**: `checkout.subtotal_amount`, use [`checkout.net_amount`](/api-reference/checkouts/get-session#response-net-amount) instead. ## New order status and webhooks Until now, Polar only kept track of fully processed, **paid** orders. To help you keep track of the order lifecycle, we've added a new status `pending`, which is a transitive state meaning the order is created but not paid yet. In most cases, the order will transition from `pending` to `paid` in a short time. * When receiving `order.created` event, the order status might not be `paid`. * **Added**: [`order.updated`](/api-reference/webhooks/order.updated) webhook, sent when the order status changes or when it's partially or fully refunded. * **Added**: [`order.paid`](/api-reference/webhooks/order.paid) webhook, sent when the order is fully processed and paid. * **Added**: [`Order.paid`](/api-reference/orders/get#response-paid) property to the order schema. If you were relying on the `order.created` webhook to keep track of succesful orders, we recommend you to switch to `order.paid`. ## Subscriptions and Orders schema changes To prepare our next move to support usage-based billing, we've made some changes to the [`Subscription`](/api-reference/subscriptions/get) and [`Order`](/api-reference/orders/get) schemas. The main reason behind those is that we need to support multiple prices and items in a single subscription or order. * **Deprecated**: `Subscription.price_id` and `Subscription.price`. Use the `Subscription.prices` array instead. * **Deprecated**: `Order.product_price_id` and `Order.product_price`. Use the `Order.items` array instead. * **Deprecated**: `Order.amount`. Use the `Order.net_amount` instead. It has the same value and meaning, but the new name is more explicit. * **Added**: `Order.subtotal_amount`, `Order.discount_amount`, and `Order.total_amount` fields to provide a more detailed breakdown of the order amount. --- # Source: https://polar.sh/docs/api-reference/customer-seats/assign.md # Source: https://polar.sh/docs/api-reference/customer-portal/seats/assign.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Assign Seat ## OpenAPI ````yaml post /v1/customer-portal/seats openapi: 3.1.0 info: title: Polar API summary: Polar HTTP and Webhooks API description: Read the docs at https://polar.sh/docs/api-reference version: 0.1.0 servers: - url: https://api.polar.sh description: Production environment x-speakeasy-server-id: production - url: https://sandbox-api.polar.sh description: Sandbox environment x-speakeasy-server-id: sandbox security: - access_token: [] tags: - name: public description: >- Endpoints shown and documented in the Polar API documentation and available in our SDKs. - name: private description: >- Endpoints that should appear in the schema only in development to generate our internal JS SDK. - name: mcp description: Endpoints enabled in the MCP server. paths: /v1/customer-portal/seats: post: tags: - customer_portal - seats - public summary: Assign Seat operationId: customer_portal:seats:assign_seat requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SeatAssign' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerSeat' '400': description: No available seats or customer already has a seat '401': description: Authentication required '403': description: Not permitted or seat-based pricing not enabled '404': description: Subscription, order, or customer not found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - customer_session: - customer_portal:write - member_session: - customer_portal:write components: schemas: SeatAssign: properties: subscription_id: anyOf: - type: string format: uuid - type: 'null' title: Subscription Id description: >- Subscription ID. Required if checkout_id and order_id are not provided. checkout_id: anyOf: - type: string format: uuid - type: 'null' title: Checkout Id description: >- Checkout ID. Used to look up subscription or order from the checkout page. order_id: anyOf: - type: string format: uuid - type: 'null' title: Order Id description: >- Order ID for one-time purchases. Required if subscription_id and checkout_id are not provided. email: anyOf: - type: string format: email - type: 'null' title: Email description: Email of the customer to assign the seat to external_customer_id: anyOf: - type: string - type: 'null' title: External Customer Id description: External customer ID for the seat assignment customer_id: anyOf: - type: string format: uuid - type: 'null' title: Customer Id description: Customer ID for the seat assignment metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata description: Additional metadata for the seat (max 10 keys, 1KB total) immediate_claim: type: boolean title: Immediate Claim description: >- If true, the seat will be immediately claimed without sending an invitation email. API-only feature. default: false type: object title: SeatAssign CustomerSeat: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid title: Id description: The seat ID subscription_id: anyOf: - type: string format: uuid - type: 'null' title: Subscription Id description: The subscription ID (for recurring seats) order_id: anyOf: - type: string format: uuid - type: 'null' title: Order Id description: The order ID (for one-time purchase seats) status: $ref: '#/components/schemas/SeatStatus' description: Status of the seat customer_id: anyOf: - type: string format: uuid - type: 'null' title: Customer Id description: >- The customer ID. When member_model_enabled is true, this is the billing customer (purchaser). When false, this is the seat member customer. member_id: anyOf: - type: string format: uuid - type: 'null' title: Member Id description: The member ID of the seat occupant email: anyOf: - type: string - type: 'null' title: Email description: Email of the seat member (set when member_model_enabled is true) customer_email: anyOf: - type: string - type: 'null' title: Customer Email description: The assigned customer email invitation_token_expires_at: anyOf: - type: string format: date-time - type: 'null' title: Invitation Token Expires At description: When the invitation token expires claimed_at: anyOf: - type: string format: date-time - type: 'null' title: Claimed At description: When the seat was claimed revoked_at: anyOf: - type: string format: date-time - type: 'null' title: Revoked At description: When the seat was revoked seat_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Seat Metadata description: Additional metadata for the seat type: object required: - created_at - modified_at - id - status title: CustomerSeat HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError SeatStatus: type: string enum: - pending - claimed - revoked title: SeatStatus ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. customer_session: type: http description: >- Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the [Create Customer Session endpoint](/api-reference/customer-portal/sessions/create). scheme: bearer member_session: type: http description: >- Member session tokens are specific tokens that are used to authenticate members on your organization. You can create those sessions programmatically using the [Create Member Session endpoint](/api-reference/member-portal/sessions/create). scheme: bearer ```` --- # Source: https://polar.sh/docs/integrate/sdk/adapters/astro.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Astro > Payments and Checkouts made dead simple with Astro ## Examples * [With Astro](https://github.com/polarsource/examples/tree/main/with-astro) * [With Astro and Cloudflare Workers](https://github.com/polarsource/examples/tree/main/with-astro-cloudflare-workers) ## Installation Install the required Polar packages using the following command: ```bash Terminal theme={null} npm install zod @polar-sh/astro ``` ```bash Terminal theme={null} yarn add zod @polar-sh/astro ``` ```bash Terminal theme={null} pnpm add zod @polar-sh/astro ``` ```bash Terminal theme={null} bun add zod @polar-sh/astro ``` ## Checkout Create a Checkout handler which takes care of redirections. ```typescript icon="square-js" theme={null} import { Checkout } from "@polar-sh/astro"; import { POLAR_ACCESS_TOKEN, POLAR_SUCCESS_URL } from "astro:env/server"; export const GET = Checkout({ accessToken: POLAR_ACCESS_TOKEN, successUrl: POLAR_SUCCESS_URL, returnUrl: "https://myapp.com", // An optional URL which renders a back-button in the Checkout server: "sandbox", // Use sandbox if you're testing Polar - omit the parameter or pass 'production' otherwise theme: "dark", // Enforces the theme - System-preferred theme will be set if left omitted }); ``` ### Query Params Pass query params to this route. * products `?products=123` * customerId (optional) `?products=123&customerId=xxx` * customerExternalId (optional) `?products=123&customerExternalId=xxx` * customerEmail (optional) `?products=123&customerEmail=janedoe@gmail.com` * customerName (optional) `?products=123&customerName=Jane` * metadata (optional) `URL-Encoded JSON string` ## Customer Portal Create a customer portal where your customer can view orders and subscriptions. ```typescript icon="square-js" theme={null} import { CustomerPortal } from "@polar-sh/astro"; import { POLAR_ACCESS_TOKEN } from "astro:env/server"; export const GET = CustomerPortal({ accessToken: POLAR_ACCESS_TOKEN, getCustomerId: (event) => "", // Function to resolve a Polar Customer ID returnUrl: "https://myapp.com", // An optional URL which renders a back-button in the Customer Portal server: "sandbox", // Use sandbox if you're testing Polar - omit the parameter or pass 'production' otherwise }); ``` ## Webhooks A simple utility which resolves incoming webhook payloads by signing the webhook secret properly. ```typescript icon="square-js" theme={null} import { Webhooks } from '@polar-sh/astro'; import { POLAR_WEBHOOK_SECRET } from "astro:env/server" export const POST = Webhooks({ webhookSecret: POLAR_WEBHOOK_SECRET, onPayload: async (payload) => /** Handle payload */, }) ``` ### Payload Handlers The Webhook handler also supports granular handlers for easy integration. * `onPayload` - Catch-all handler for any incoming Webhook event * `onCheckoutCreated` - Triggered when a checkout is created * `onCheckoutUpdated` - Triggered when a checkout is updated * `onOrderCreated` - Triggered when an order is created * `onOrderPaid` - Triggered when an order is paid * `onOrderRefunded` - Triggered when an order is refunded * `onRefundCreated` - Triggered when a refund is created * `onRefundUpdated` - Triggered when a refund is updated * `onSubscriptionCreated` - Triggered when a subscription is created * `onSubscriptionUpdated` - Triggered when a subscription is updated * `onSubscriptionActive` - Triggered when a subscription becomes active * `onSubscriptionCanceled` - Triggered when a subscription is canceled * `onSubscriptionRevoked` - Triggered when a subscription is revoked * `onSubscriptionUncanceled` - Triggered when a subscription cancellation is reversed * `onProductCreated` - Triggered when a product is created * `onProductUpdated` - Triggered when a product is updated * `onOrganizationUpdated` - Triggered when an organization is updated * `onBenefitCreated` - Triggered when a benefit is created * `onBenefitUpdated` - Triggered when a benefit is updated * `onBenefitGrantCreated` - Triggered when a benefit grant is created * `onBenefitGrantUpdated` - Triggered when a benefit grant is updated * `onBenefitGrantRevoked` - Triggered when a benefit grant is revoked * `onCustomerCreated` - Triggered when a customer is created * `onCustomerUpdated` - Triggered when a customer is updated * `onCustomerDeleted` - Triggered when a customer is deleted * `onCustomerStateChanged` - Triggered when a customer state changes --- # Source: https://polar.sh/docs/integrate/authentication.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Authentication All bearer tokens should be kept private and never shared or exposed in client-side code. To authenticate requests, Polar API has two mechanisms. 1. [Organization Access Tokens (OAT)](/integrate/oat) - Recommended 2. [OAuth 2.0 Provider](/integrate/oauth2/introduction) (Partner Integrations) ## Organization Access Tokens (OAT) They are tied to **one** of your organization. You can create them from your organization settings. ## Security To protect your data and ensure the security of Polar, we've several mechanisms in place to automatically revoke tokens that may have been leaked publicly on the web. In particular, we're part of the [GitHub Secret Scanning Program](https://docs.github.com/en/code-security/secret-scanning/about-secret-scanning). If GitHub systems detect a Polar token in a code repository or public discussion, our systems are notified and the tokens are immediately revoked. If you received an email about one of your token being leaked, it means that we were notified of such situation. The email contains the details about the nature of the token and the source of the leak. In the future, it's crucial that you remain extra cautious about not leaking your tokens publicly online. You can read more about the good practices to manage secrets in the [OWASP Secrets Management Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Secrets_Management_Cheat_Sheet.html). --- # Source: https://polar.sh/docs/api-reference/oauth2/connect/authorize.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Authorize ## OpenAPI ````yaml get /v1/oauth2/authorize openapi: 3.1.0 info: title: Polar API summary: Polar HTTP and Webhooks API description: Read the docs at https://polar.sh/docs/api-reference version: 0.1.0 servers: - url: https://api.polar.sh description: Production environment x-speakeasy-server-id: production - url: https://sandbox-api.polar.sh description: Sandbox environment x-speakeasy-server-id: sandbox security: - access_token: [] tags: - name: public description: >- Endpoints shown and documented in the Polar API documentation and available in our SDKs. - name: private description: >- Endpoints that should appear in the schema only in development to generate our internal JS SDK. - name: mcp description: Endpoints enabled in the MCP server. paths: /v1/oauth2/authorize: get: tags: - oauth2 - public summary: Authorize operationId: oauth2:authorize responses: '200': description: Successful Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/AuthorizeResponseUser' - $ref: '#/components/schemas/AuthorizeResponseOrganization' title: Response Oauth2:Authorize discriminator: propertyName: sub_type mapping: user: '#/components/schemas/AuthorizeResponseUser' organization: '#/components/schemas/AuthorizeResponseOrganization' components: schemas: AuthorizeResponseUser: properties: client: $ref: '#/components/schemas/OAuth2ClientPublic' sub_type: type: string const: user title: Sub Type sub: anyOf: - $ref: '#/components/schemas/AuthorizeUser' - type: 'null' scopes: items: $ref: '#/components/schemas/Scope' type: array title: Scopes scope_display_names: additionalProperties: type: string type: object title: Scope Display Names default: openid: OpenID profile: Read your profile email: Read your email address web:read: Web Read Access web:write: Web Write Access user:read: User Read user:write: Delete your user account organizations:read: Read your organizations organizations:write: Create or modify organizations custom_fields:read: Read custom fields custom_fields:write: Create or modify custom fields discounts:read: Read discounts discounts:write: Create or modify discounts checkout_links:read: Read checkout links checkout_links:write: Create or modify checkout links checkouts:read: Read checkout sessions checkouts:write: Create or modify checkout sessions transactions:read: Read transactions transactions:write: Create or modify transactions payouts:read: Read payouts payouts:write: Create or modify payouts products:read: Read products products:write: Create or modify products benefits:read: Read benefits benefits:write: Create or modify benefits events:read: Read events events:write: Create events meters:read: Read meters meters:write: Create or modify meters files:read: Read file uploads files:write: Create or modify file uploads subscriptions:read: Read subscriptions made on your organizations subscriptions:write: Create or modify subscriptions made on your organizations customers:read: Read customers customers:write: Create or modify customers members:read: Read members members:write: Create or modify members wallets:read: Read wallets wallets:write: Create or modify wallets disputes:read: Read disputes customer_meters:read: Read customer meters customer_sessions:write: Create or modify customer sessions member_sessions:write: Create or modify member sessions customer_seats:read: Read customer seats customer_seats:write: Create or modify customer seats orders:read: Read orders made on your organizations orders:write: Modify orders made on your organizations refunds:read: Read refunds made on your organizations refunds:write: Create or modify refunds payments:read: Read payments made on your organizations metrics:read: Read metrics webhooks:read: Read webhooks webhooks:write: Create or modify webhooks external_organizations:read: Read external organizations license_keys:read: Read license keys license_keys:write: Modify license keys customer_portal:read: Read your orders, subscriptions and benefits customer_portal:write: Create or modify your orders, subscriptions and benefits notifications:read: Read notifications notifications:write: Mark notifications as read notification_recipients:read: Read notification recipients notification_recipients:write: Create or modify notification recipients organization_access_tokens:read: Read organization access tokens organization_access_tokens:write: Create or modify organization access tokens type: object required: - client - sub_type - sub - scopes title: AuthorizeResponseUser AuthorizeResponseOrganization: properties: client: $ref: '#/components/schemas/OAuth2ClientPublic' sub_type: type: string const: organization title: Sub Type sub: anyOf: - $ref: '#/components/schemas/AuthorizeOrganization' - type: 'null' scopes: items: $ref: '#/components/schemas/Scope' type: array title: Scopes scope_display_names: additionalProperties: type: string type: object title: Scope Display Names default: openid: OpenID profile: Read your profile email: Read your email address web:read: Web Read Access web:write: Web Write Access user:read: User Read user:write: Delete your user account organizations:read: Read your organizations organizations:write: Create or modify organizations custom_fields:read: Read custom fields custom_fields:write: Create or modify custom fields discounts:read: Read discounts discounts:write: Create or modify discounts checkout_links:read: Read checkout links checkout_links:write: Create or modify checkout links checkouts:read: Read checkout sessions checkouts:write: Create or modify checkout sessions transactions:read: Read transactions transactions:write: Create or modify transactions payouts:read: Read payouts payouts:write: Create or modify payouts products:read: Read products products:write: Create or modify products benefits:read: Read benefits benefits:write: Create or modify benefits events:read: Read events events:write: Create events meters:read: Read meters meters:write: Create or modify meters files:read: Read file uploads files:write: Create or modify file uploads subscriptions:read: Read subscriptions made on your organizations subscriptions:write: Create or modify subscriptions made on your organizations customers:read: Read customers customers:write: Create or modify customers members:read: Read members members:write: Create or modify members wallets:read: Read wallets wallets:write: Create or modify wallets disputes:read: Read disputes customer_meters:read: Read customer meters customer_sessions:write: Create or modify customer sessions member_sessions:write: Create or modify member sessions customer_seats:read: Read customer seats customer_seats:write: Create or modify customer seats orders:read: Read orders made on your organizations orders:write: Modify orders made on your organizations refunds:read: Read refunds made on your organizations refunds:write: Create or modify refunds payments:read: Read payments made on your organizations metrics:read: Read metrics webhooks:read: Read webhooks webhooks:write: Create or modify webhooks external_organizations:read: Read external organizations license_keys:read: Read license keys license_keys:write: Modify license keys customer_portal:read: Read your orders, subscriptions and benefits customer_portal:write: Create or modify your orders, subscriptions and benefits notifications:read: Read notifications notifications:write: Mark notifications as read notification_recipients:read: Read notification recipients notification_recipients:write: Create or modify notification recipients organization_access_tokens:read: Read organization access tokens organization_access_tokens:write: Create or modify organization access tokens organizations: items: $ref: '#/components/schemas/AuthorizeOrganization' type: array title: Organizations type: object required: - client - sub_type - sub - scopes - organizations title: AuthorizeResponseOrganization OAuth2ClientPublic: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. client_id: type: string title: Client Id client_name: anyOf: - type: string - type: 'null' title: Client Name client_uri: anyOf: - type: string - type: 'null' title: Client Uri logo_uri: anyOf: - type: string - type: 'null' title: Logo Uri tos_uri: anyOf: - type: string - type: 'null' title: Tos Uri policy_uri: anyOf: - type: string - type: 'null' title: Policy Uri type: object required: - created_at - modified_at - client_id - client_name - client_uri - logo_uri - tos_uri - policy_uri title: OAuth2ClientPublic AuthorizeUser: properties: id: type: string format: uuid4 title: Id email: type: string format: email title: Email avatar_url: anyOf: - type: string - type: 'null' title: Avatar Url type: object required: - id - email - avatar_url title: AuthorizeUser Scope: type: string enum: - openid - profile - email - user:read - user:write - web:read - web:write - organizations:read - organizations:write - custom_fields:read - custom_fields:write - discounts:read - discounts:write - checkout_links:read - checkout_links:write - checkouts:read - checkouts:write - transactions:read - transactions:write - payouts:read - payouts:write - products:read - products:write - benefits:read - benefits:write - events:read - events:write - meters:read - meters:write - files:read - files:write - subscriptions:read - subscriptions:write - customers:read - customers:write - members:read - members:write - wallets:read - wallets:write - disputes:read - customer_meters:read - customer_sessions:write - member_sessions:write - customer_seats:read - customer_seats:write - orders:read - orders:write - refunds:read - refunds:write - payments:read - metrics:read - webhooks:read - webhooks:write - external_organizations:read - license_keys:read - license_keys:write - repositories:read - repositories:write - issues:read - issues:write - customer_portal:read - customer_portal:write - notifications:read - notifications:write - notification_recipients:read - notification_recipients:write - organization_access_tokens:read - organization_access_tokens:write title: Scope enumNames: benefits:read: Read benefits benefits:write: Create or modify benefits checkout_links:read: Read checkout links checkout_links:write: Create or modify checkout links checkouts:read: Read checkout sessions checkouts:write: Create or modify checkout sessions custom_fields:read: Read custom fields custom_fields:write: Create or modify custom fields customer_meters:read: Read customer meters customer_portal:read: Read your orders, subscriptions and benefits customer_portal:write: Create or modify your orders, subscriptions and benefits customer_seats:read: Read customer seats customer_seats:write: Create or modify customer seats customer_sessions:write: Create or modify customer sessions customers:read: Read customers customers:write: Create or modify customers discounts:read: Read discounts discounts:write: Create or modify discounts disputes:read: Read disputes email: Read your email address events:read: Read events events:write: Create events external_organizations:read: Read external organizations files:read: Read file uploads files:write: Create or modify file uploads license_keys:read: Read license keys license_keys:write: Modify license keys member_sessions:write: Create or modify member sessions members:read: Read members members:write: Create or modify members meters:read: Read meters meters:write: Create or modify meters metrics:read: Read metrics notification_recipients:read: Read notification recipients notification_recipients:write: Create or modify notification recipients notifications:read: Read notifications notifications:write: Mark notifications as read openid: OpenID orders:read: Read orders made on your organizations orders:write: Modify orders made on your organizations organization_access_tokens:read: Read organization access tokens organization_access_tokens:write: Create or modify organization access tokens organizations:read: Read your organizations organizations:write: Create or modify organizations payments:read: Read payments made on your organizations payouts:read: Read payouts payouts:write: Create or modify payouts products:read: Read products products:write: Create or modify products profile: Read your profile refunds:read: Read refunds made on your organizations refunds:write: Create or modify refunds subscriptions:read: Read subscriptions made on your organizations subscriptions:write: Create or modify subscriptions made on your organizations transactions:read: Read transactions transactions:write: Create or modify transactions user:read: User Read user:write: Delete your user account wallets:read: Read wallets wallets:write: Create or modify wallets web:read: Web Read Access web:write: Web Write Access webhooks:read: Read webhooks webhooks:write: Create or modify webhooks AuthorizeOrganization: properties: id: type: string format: uuid4 title: Id slug: type: string title: Slug avatar_url: anyOf: - type: string - type: 'null' title: Avatar Url type: object required: - id - slug - avatar_url title: AuthorizeOrganization securitySchemes: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. ```` --- # Source: https://polar.sh/docs/guides/automate-post-purchase-link-sharing.md > ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # How to automatically share links to customers after purchase > Learn how to use the Custom Benefit to automatically share links with customers after purchase. ## Create a Custom Benefit In the Polar dashboard sidebar, click on **Benefits**. You can also go directly to `https://polar.sh/dashboard/${org_slug}/products/benefits`.