# Adding a product
Source: https://docs.blink.store/add-products



Add your products and start selling

## Product types

The info tab is where you add basic product into<br /><br />**One-time**

One-time products are purchased once with a single payment. Ideal for digital products, services, templates, ebooks, courses, software licenses, and other items that don’t require recurring billing.

**Subscription**

Subscriptions charge customers automatically on a recurring schedule such as weekly, monthly, or yearly. Ideal for memberships, communities, SaaS products, newsletters, retainers, and ongoing services.

**Bundles**

Bundles allow you to group multiple existing products together and sell them as a single package, often at a discounted rate. Ideal for creating ultimate toolkits, premium collections, and promotional packages to incentivize customers and increase your average order value.

***

## Info

The info tab is where you add basic product into

<Accordion title="Product name">
  Simply add your product desired name
</Accordion>

<Accordion title="Checkout URL">
  Checkout URL is how your product look like in the browser bar for example: [*https://yourstore.blink.store/bungee-framer-template*](https://yourstore.blink.store/bungee-framer-template)

  URLs must not contain any spaces and should be all in small letters.

  When creating your product, it's automatically assigned a URL similar to your product name, feel free to change that to a custom one.
</Accordion>

<Accordion title="Description">
  Blink comes with a powerful, flexible rich text editor that gives you full control over how your content looks and feels. You can easily add headings, paragraphs, links, and lists, and style everything to match your voice and brand. Whether you’re keeping it clean and minimal or going more detailed and structured, you can format your description exactly the way you want—no limitations, no fuss.
</Accordion>

<Accordion title="Pricing">
  **Free:**<br />Offer your product free to all customers.<br /><br />**Paid:**<br />Set a price to your product according to your store's currency.<br /><br />**Pay what you want:**<br />Pay What You Want (PWYW) pricing is a strategy where sellers allow buyers to determine the price for a product or service, often with an optional minimum, including zero.
</Accordion>

<Accordion title="Currency">
  You can set a currency per product, which overrides the store’s default currency if it differs.<br /><br />**Supported currencies:**

  * USD (US Dollar)
  * EUR (EURO)
  * GBP (British Pound)
  * CAD (Canadian Dollar)
  * AUD (Australian Dollar)
  * JPY (Japanese Yen)
  * CHF (Swiss Franc)
  * SEK (Swedish Krona)
  * INR (Indian Rupee)
  * BRL (Brazilian Real)Tax
</Accordion>

***

## Images

You can upload up to 10 images for each product, giving you plenty of room to show it off from every angle.

For best results, we recommend using images that are at least 1600 × 1200px so everything looks sharp and clear.

Supported formats: JPEG, PNG, and WebP

***

## Deliverables

Deliverables are what your customer receives after placing an order.<br />For maximum flexibility, you can attach any of the following deliverables to fully automate your fulfillment:

[Learn more about deliverable types](/deliverables)

***

## Settings

Variable products allow customers to choose options like size or color on one page, with unique prices, SKUs, and stock levels for each combination.

<Accordion title="Cart recovery">
  Recover lost sales automatically with a 3-step abandoned checkout flow. When a customer drops off, we send a series of high-converting emails to bring them back complete with built-in incentives. The second and third emails include a discount to nudge them over the line.
</Accordion>

<Accordion title="Bumps">
  Order bumps are a simple way to increase your checkout value. They appear right before the Pay button and let customers quickly add extras to their order with a single click.

  They’re perfect for offering complementary add-ons like extended support, setup services, or premium extras.
</Accordion>

<Accordion title="Visibility">
  Choose how you want your product to be discovered. You can make it visible on your storefront for anyone to browse, or keep it private and share it only via direct link.
</Accordion>

<Accordion title="Subscription Revocation">
  For subscription products, you can enable the **"Revoke access on subscription end"** setting. When enabled, Blink automatically locks access to digital downloads, API keys, Entitlements (Feature Flags), Discord roles, and GitHub repositories when the subscription expires, cancels, or fails to renew.
</Accordion>

<Note>
  Blink only allows adding digital products you own, adding a product that infringes copyrights may result in immediate termination of your account.
</Note>


# Manage
Source: https://docs.blink.store/affiliate-manage



The **Affiliates** section allows you to review applications, approve affiliates, monitor performance, and manage your program.

## **Affiliate Statuses**

### **Pending**

Applicants awaiting review.

These affiliates have submitted an application but cannot promote your products until approved.

### **Approved**

Active affiliates who can generate referrals and earn commissions.

### **Banned**

Affiliates removed from your program.

Banned affiliates can no longer earn commissions or generate new referrals.

## **Affiliate Overview**

The affiliate list provides a high-level view of each affiliate’s performance.

### **Clicks**

The number of visitors who clicked the affiliate’s referral links.

### **Earnings**

The total commissions generated by the affiliate.

### **Referrals**

The number of successful referred purchases.

### **Status**

The affiliate’s current approval status.

## **Viewing Affiliate Details**

Click any affiliate to access detailed performance information.

### **Performance Metrics**

#### **Clicks**

Total tracked visits generated by the affiliate.

#### **Referrals**

Total successful purchases attributed to the affiliate.

#### **Unpaid Earnings**

Approved commissions that have not yet been paid out.

#### **Total Earnings**

Lifetime commissions earned by the affiliate.

## **Referral Activity**

The Recent Referrals section displays every successful referral generated by the affiliate.

For each referral you can view:

* Date
* Product purchased
* Commission earned
* Payout status

## **Affiliate Information**

The Information tab contains the affiliate’s application details and profile information submitted during signup.

This information helps you evaluate affiliates and maintain quality partnerships.

## **Managing Affiliate Status**

You can update an affiliate’s status at any time.

### **Approve**

Allows the affiliate to actively promote your products and earn commissions.

### **Move to Pending**

Temporarily pauses approval while you review the account.

### **Ban**

Removes the affiliate from your program and prevents future commission generation.


# Payouts
Source: https://docs.blink.store/affiliate-payouts



Blink automatically manages affiliate payouts using Stripe Connect.

Commissions are tracked, approved, and prepared for payout without requiring manual calculations.

## **How Payouts Work**

1. An affiliate refers a customer.
2. The customer completes a purchase.
3. The commission is recorded.
4. The commission enters an escrow period.
5. Once eligible, funds are released automatically through Stripe Connect.

## **Escrow Period**

Affiliate commissions are held for **30 days** before becoming eligible for payout.

This helps protect against:

* Refunds
* Chargebacks
* Fraudulent purchases
* Payment disputes

## **Automatic Distribution**

Once a commission passes the escrow period and meets the minimum payout threshold:

* Blink automatically prepares the payout.
* Stripe Connect handles the fund transfer.
* No manual payout requests are required.

## **Tracking Payouts**

The Payouts page displays commissions that are ready or scheduled for payment.

You can use this page to monitor the payout pipeline and verify upcoming affiliate earnings.

## **Important Notes**

* Affiliates must have a connected Blink account to receive payouts.
* Only approved commissions become eligible for payout.
* Refunds and disputes may affect commission eligibility.
* Commissions are paid only after the escrow period has completed.
* Payout processing is handled automatically through Stripe Connect.


# Setup
Source: https://docs.blink.store/affiliate-setup



The Affiliate Program allows creators, customers, and marketers to promote your products in exchange for a commission on successful referrals.

Once enabled, affiliates can apply to join your program, receive unique tracking links, and earn commissions when their referrals generate sales.

## **Enabling Your Affiliate Program**

Navigate to **Affiliate Program → Settings** and enable the program.

When enabled:

* Your public affiliate signup page becomes available.
* Applicants can submit requests to join your program.
* Approved affiliates receive access to referral links and performance tracking.

***

## Default affiliate program

The Default Affiliate Program serves as your baseline offer for anyone joining through your public affiliate page.

<Note>
  For custom deal structures, you can build Private Affiliate Programs with tailored terms and commission rules, accessible exclusively via direct link.
</Note>

## **Affiliate Signup Page**

Every store receives a unique affiliate application page.

Use the **Invite Link** to:

* Recruit affiliates directly.
* Share your program on social media.
* Add the link to your website or creator resources.
* Invite existing customers to become affiliates.

## **Commission Structure**

Choose how affiliates are rewarded for successful referrals.

### **Percentage Commission**

Affiliates earn a percentage of each qualifying sale.

**Example**

Product sells for \$100

* Affiliate earns \$20 (20%)
* Store owner receives \$80

### **Fixed Amount Commission**

Affiliates earn a fixed amount per sale regardless of product price.

**Example**

Product sells for \$100

* Affiliate earns \$10
* Store owner receives \$90

## **Minimum Payout**

Set the minimum earnings balance required before an affiliate becomes eligible for payout.

**Example**

Minimum payout: \$50

An affiliate must accumulate at least \$50 in approved commissions before funds can be released.

## **Cookie Duration**

Cookie duration determines how long Blink tracks a visitor after they click an affiliate link.

**Example**

Cookie duration: 30 days

If a visitor clicks an affiliate link and purchases within 30 days, the affiliate receives credit for the sale.

## **Automatic Approval**

Enable **Automatically approve new affiliates** if you want applicants to join instantly without manual review.

When disabled:

* Applications are placed into a pending state.
* You review and approve affiliates manually.

## **Application Questions**

Customize the application process by asking potential affiliates questions before approval.

Common examples include:

* How will you promote our products?
* Tell us about your audience.
* Share your website or social profiles.
* How did you hear about us?

Use these responses to identify high-quality affiliates and prevent abuse.


# Analytics
Source: https://docs.blink.store/analytics



Blink Analytics helps you understand where your traffic comes from, how visitors behave, and what drives sales. Track your store’s performance in real time with insights across traffic, marketing campaigns, products, checkouts, and conversions.

## **Overview Metrics**

At the top of the Analytics dashboard, you’ll find your key performance indicators:

* **Total Visitors** — The number of unique visitors to your storefront.
* **Page Views** — The total number of pages viewed across your store.
* **Avg Time on Site** — The average time visitors spend browsing your store.
* **Bounce Rate** — The percentage of visitors who leave without interacting further.
* **Checkouts Initiated** — The number of checkout sessions started.
* **Checkout Conversion** — The percentage of visitors who completed a purchase.

## **Traffic Over Time**

The traffic chart visualizes visitor activity over your selected date range, helping you identify trends, spikes, and the impact of campaigns or product launches.

Use the date picker to analyze performance across different periods.

## **Marketing Campaigns**

Track the performance of your marketing campaigns using UTM parameters.

Filter by:

* **All UTMs**
* **Campaign**
* **Source**
* **Medium**
* **Term**
* **Content**

For each campaign, Blink reports:

* Number of visits
* Generated revenue
* Conversion rate

This allows you to understand which channels and campaigns drive the highest return.

## **Referrers**

See exactly where your visitors are coming from.

Common sources include:

* Direct traffic
* Search engines
* Social platforms
* Marketplaces
* External websites
* Custom referral links

For each referrer, Blink tracks:

* Visits
* Revenue generated
* Conversion rate

## **Countries**

Understand your audience’s geographic distribution.

Country analytics help you:

* Identify your strongest markets
* Discover emerging audiences
* Optimize geo-pricing strategies
* Localize your marketing efforts

Each country includes visitor count, revenue, and conversion performance.

## **Devices**

Analyze how visitors access your store across different device types, including:

* Desktop
* Mobile
* Laptop
* Tablet

Device analytics can help optimize your store experience and improve conversion rates.

## **Checkouts**

Track which checkout experiences perform best.

Blink currently tracks performance across:

* **Storefront Checkout**
* **Overlay Checkout**
* **Light Mode Checkout**

Compare checkout starts, revenue, and conversion rates to identify the most effective purchasing experience.

## **Product Performance**

Measure how each product performs individually.

For every product, Blink tracks:

* Page views
* Unique visitors
* Sales volume
* Conversion rate
* Net revenue

Use these insights to identify your best-performing products, optimize pricing, and focus your marketing efforts where they matter most.

## **Privacy First**

Analytics are aggregated asynchronously and powered by privacy-friendly tracking. Data can be slightly delayed.


# Create affiliate link
Source: https://docs.blink.store/api-reference/affiliates/create-affiliate-link

post /affiliates/members/{membership_id}/links



# Generate custom affiliate link
Source: https://docs.blink.store/api-reference/affiliates/generate-custom-affiliate-link

post /affiliates/links
Generates a custom tracking link for an affiliate membership using a specific code.

**Usage:** Allows affiliates to create personalized links that can track their referral traffic and conversions.



# Generate Single Sign-On (SSO) URL
Source: https://docs.blink.store/api-reference/affiliates/generate-single-sign-on-sso-url

post /v1/affiliates/sso
Generates a magic link URL to seamlessly log an affiliate into their dashboard.



# Get affiliate conversions
Source: https://docs.blink.store/api-reference/affiliates/get-affiliate-conversions

get /affiliates/{id}/conversions
Retrieves a list of orders that are attributed to a specific affiliate based on their membership ID. Provides detailed order information, including the status, amount, and commission.

**Usage:** Allows affiliates to track their performance and commissions by viewing the orders they have influenced.



# Get affiliate finances
Source: https://docs.blink.store/api-reference/affiliates/get-affiliate-finances

get /affiliates/members/{membership_id}/finances



# Get Affiliate Links
Source: https://docs.blink.store/api-reference/affiliates/get-affiliate-links

get /v1/affiliates/{id}/links
Fetch tracking links for a specific affiliate membership.



# Get affiliate metrics
Source: https://docs.blink.store/api-reference/affiliates/get-affiliate-metrics

get /affiliates/members/{membership_id}/metrics



# Get Affiliate Program Settings
Source: https://docs.blink.store/api-reference/affiliates/get-affiliate-program-settings

get /v1/affiliate-program
Fetch the active affiliate program configuration for the store.



# Initialize Payout Setup
Source: https://docs.blink.store/api-reference/affiliates/initialize-payout-setup

post /v1/affiliates/{id}/payout-setup
Generates a secure Stripe Connect onboarding link for the affiliate. Handles the creation of the underlying Stripe Express account if it doesn't exist.



# Invite an affiliate
Source: https://docs.blink.store/api-reference/affiliates/invite-an-affiliate

post /affiliates/invite
Programmatically sends an email invitation to a potential affiliate. The email contains a link for joining the affiliate program.

**Usage:** Useful for programatically adding affiliates to expand marketing reach.



# List affiliate links
Source: https://docs.blink.store/api-reference/affiliates/list-affiliate-links

get /affiliates/members/{membership_id}/links



# List affiliate members
Source: https://docs.blink.store/api-reference/affiliates/list-affiliate-members

get /affiliates/members



# List affiliate orders
Source: https://docs.blink.store/api-reference/affiliates/list-affiliate-orders

get /affiliates/members/{membership_id}/orders



# List affiliate programs
Source: https://docs.blink.store/api-reference/affiliates/list-affiliate-programs

get /affiliates/programs



# List affiliates
Source: https://docs.blink.store/api-reference/affiliates/list-affiliates

get /affiliates
Retrieves a list of affiliates for a store, with optional filtering by status and pagination support.

**Usage:** Analyze and manage affiliates for promotional strategies.



# Register a new affiliate
Source: https://docs.blink.store/api-reference/affiliates/register-a-new-affiliate

post /v1/affiliates/register
Headless registration for custom storefronts. Provisions a user identity, creates an affiliate profile, and enrolls them into the store's default affiliate program.



# Retrieve affiliate details
Source: https://docs.blink.store/api-reference/affiliates/retrieve-affiliate-details

get /affiliates/{id}
Retrieves details of a specific affiliate membership using its ID. It includes affiliate profile information and conversion statistics.

**Usage:** Use this to get detailed insights into an individual affiliate's performance, including total revenue and pending commissions.



# Retrieve Payout Balances
Source: https://docs.blink.store/api-reference/affiliates/retrieve-payout-balances

get /v1/affiliates/{id}/payouts
Securely fetches the affiliate's live Available and Pending balances directly from Stripe, along with their recent payout transfers and their Stripe account setup status.



# Update affiliate details
Source: https://docs.blink.store/api-reference/affiliates/update-affiliate-details

patch /affiliates/{id}
Updates the details of a specific affiliate membership using its ID. You can change the status of the affiliation.

**Usage:** Utilize this endpoint to modify affiliate statuses like changing them to 'approved', 'banned', etc.



# Update affiliate membership status
Source: https://docs.blink.store/api-reference/affiliates/update-affiliate-membership-status

post /affiliates
Approves, rejects, or bans an affiliate's application based on the action specified.

**Usage:** Control the participation of affiliates based on their performance or issues.



# AI Integration
Source: https://docs.blink.store/api-reference/ai-integration

How to instantly build Blink integrations using AI agents like Cursor, Windsurf, or Claude.

Blink provides native, first-class support for AI coding agents. Instead of manually reading through our API reference to write fetch requests or define schemas, you can point your AI directly to our **Master Agent File**.

## The Master Agent File (`llms-full.txt`)

Our documentation automatically generates an AI-optimized file at `https://docs.blink.store/llms-full.txt`. This single file contains:

1. **Blink Architectural Golden Rules:** Strict instructions on when to use Embedded checkouts, how to handle deliverables securely, and webhook best practices.
2. **Complete OpenAPI Schemas:** Every endpoint, payload, and response format in our API.

Because modern AI models (like Claude 3.5 Sonnet and GPT-4o) have massive context windows, they can instantly read this entire file and write flawless integration code on the first try.

## How to use it in Cursor or Windsurf

If you are building your integration inside an AI IDE like Cursor or Windsurf, simply `@`-mention the URL in your chat prompt.

**Example Prompt:**

> `@https://docs.blink.store/llms-full.txt` I am building a Next.js application. Please write a server action that creates a Blink checkout session for my product `prod_123`, and then write the client-side code to trigger the embedded overlay checkout when the user clicks "Buy Now".

## How to use it in ChatGPT or Claude web

If you are using ChatGPT or Claude on the web, you can either:

1. Paste the `https://docs.blink.store/llms-full.txt` URL directly into your prompt.
2. Download the `.txt` file and attach it to your "Claude Project" or "Custom GPT" as persistent knowledge.


# Delete a tag
Source: https://docs.blink.store/api-reference/audience/delete-a-tag

delete /audience/tags



# List all broadcasts
Source: https://docs.blink.store/api-reference/audience/list-all-broadcasts

get /audience/broadcasts



# List all tags
Source: https://docs.blink.store/api-reference/audience/list-all-tags

get /audience/tags



# Create a new bump
Source: https://docs.blink.store/api-reference/bumps/create-a-new-bump

post /bumps
Creates a new promotional bump for the store. Includes details like title, description, and price.

**Usage:** Use this endpoint to create new upsells and promotional offers to increase average order value.



# Delete Bump
Source: https://docs.blink.store/api-reference/bumps/delete-bump

delete /bumps/{id}



# List store bumps
Source: https://docs.blink.store/api-reference/bumps/list-store-bumps

get /bumps
Retrieves a list of promotional bumps available in the store. A bump is a special offer or upsell related to a product. The response includes details like the title, description, price, and deliverables.

**Usage:** Utilize this endpoint to analyze or display product upsells and promotions for increasing average order value.



# Retrieve a specific bump
Source: https://docs.blink.store/api-reference/bumps/retrieve-a-specific-bump

get /bumps/{id}



# Update Bump
Source: https://docs.blink.store/api-reference/bumps/update-bump

patch /bumps/{id}



# Create a New Bundle
Source: https://docs.blink.store/api-reference/bundles/create-a-new-bundle

POST https://api.blink.store/v1/products
Create a new bundle containing existing products.

### Body Parameters

<ParamField type="string">
  The name of the bundle.
</ParamField>

<ParamField type="integer">
  The total price of the bundle in cents (e.g., `4900` for \$49.00).
</ParamField>

<ParamField type="string">
  The pricing model. Usually `standard` for bundles.
</ParamField>

<ParamField type="boolean">
  Must be set to `true` to flag this product as a bundle.
</ParamField>

<ParamField type="array">
  An array of objects representing the products included in this bundle.

  <Expandable title="properties">
    <ParamField type="string">
      The ID of the existing product to include.
    </ParamField>

    <ParamField type="string">
      An optional custom description for this item within the bundle.
    </ParamField>
  </Expandable>
</ParamField>

### Response

<ResponseField name="data" type="object">
  The newly created bundle object.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      The unique identifier for the newly created bundle.
    </ResponseField>

    <ResponseField name="name" type="string">
      The name of the bundle.
    </ResponseField>

    <ResponseField name="is_bundle" type="boolean">
      Will be `true`.
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'https://api.blink.store/v1/products' \
    --header 'Authorization: Bearer YOUR_API_KEY' \
    --header 'Content-Type: application/json' \
    --header 'x-store-id: YOUR_STORE_ID' \
    --data '{
      "name": "Ultimate Toolkit",
      "price": 4900,
      "pricing_model": "standard",
      "is_bundle": true,
      "bundle_items": [
        {
          "product_id": "prod_123"
        },
        {
          "product_id": "prod_456"
        }
      ]
    }'
  ```
</RequestExample>


# List All Bundles
Source: https://docs.blink.store/api-reference/bundles/list-all-bundles

GET https://api.blink.store/v1/products
Retrieve a list of all your bundles by passing `is_bundle=true`.

### Query Parameters

<ParamField type="boolean">
  Must be set to `true` to filter the products list and only return bundles.
</ParamField>

<ParamField type="string">
  Filter by bundle status. E.g., `active`, `archived`, `draft`.
</ParamField>

<ParamField type="integer">
  Limit the number of results returned.
</ParamField>

<ParamField type="integer">
  Page number for pagination.
</ParamField>

### Response

<ResponseField name="data" type="array">
  An array of bundle objects.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      The unique identifier for the bundle.
    </ResponseField>

    <ResponseField name="name" type="string">
      The name of the bundle.
    </ResponseField>

    <ResponseField name="price" type="integer">
      The total price of the bundle in cents.
    </ResponseField>

    <ResponseField name="is_bundle" type="boolean">
      Always `true` for bundles.
    </ResponseField>

    <ResponseField name="bundle_items" type="array">
      An array of products included in the bundle.
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.blink.store/v1/products?is_bundle=true' \
    --header 'Authorization: Bearer YOUR_API_KEY' \
    --header 'x-store-id: YOUR_STORE_ID'
  ```
</RequestExample>


# Delete a cart recovery campaign
Source: https://docs.blink.store/api-reference/cart-recovery/delete-a-cart-recovery-campaign

delete /cart-recovery/{id}



# Get recovery link
Source: https://docs.blink.store/api-reference/cart-recovery/get-recovery-link

get /cart-recovery/{id}/link



# List all abandoned carts
Source: https://docs.blink.store/api-reference/cart-recovery/list-all-abandoned-carts

get /cart-recovery
Lists all abandoned carts for a store with optional filtering by cart status or product ID. Supports pagination.

**Usage:** Retrieve a list of all forgotten carts for a store. This can help in analyzing trends and planning follow-up strategies.



# Manually trigger recovery email
Source: https://docs.blink.store/api-reference/cart-recovery/manually-trigger-recovery-email

post /cart-recovery/{id}/recover
This endpoint allows you to manually trigger a recovery email for an abandoned cart specified by its ID. It checks the cart's status, and if it hasn't been recovered, it will regenerate the recovery URL using the Blink checkout session and dispatch a recovery email to the customer. It increments the recovery email sent counter regardless of email success.

**Usage:** Useful when you want to manually re-initiate the recovery process for a specific cart.



# Retrieve abandoned cart details
Source: https://docs.blink.store/api-reference/cart-recovery/retrieve-abandoned-cart-details

get /cart-recovery/{id}
Retrieves details of a specific abandoned cart using its ID. The response includes information about the cart, such as customer email, status, and product details.

**Usage:** Use this endpoint to view details of a forgotten cart, aiding in customer follow-up or analytics.



# Trigger a recovery email
Source: https://docs.blink.store/api-reference/cart-recovery/trigger-a-recovery-email

post /cart-recovery/trigger
Manually sends a recovery email for a specified abandoned cart. This endpoint can be used to re-initiate customer communication for carts awaiting recovery.

**Usage:** Directly reach out to customers who have left items in their carts, potentially increasing order completion rates.



# Create a new checkout session
Source: https://docs.blink.store/api-reference/checkouts/create-a-new-checkout-session

post /checkouts
Initializes a new Blink checkout session for a product and returns the session URL. Can be customized with discounts, affiliate codes, and display preferences.

**Usage:** This endpoint is crucial for starting a payment flow and redirecting customers to a payment page.



# Create Checkout Link
Source: https://docs.blink.store/api-reference/checkouts/create-checkout-link

post /checkout-links
Creates a permanent checkout link.

**Usage:** Automatically generating short-links for influencer marketing campaigns.



# Delete Checkout Link
Source: https://docs.blink.store/api-reference/checkouts/delete-checkout-link

delete /checkout-links/{id}



# List Checkout Links
Source: https://docs.blink.store/api-reference/checkouts/list-checkout-links

get /checkout-links
Lists reusable checkout links.



# List checkout sessions
Source: https://docs.blink.store/api-reference/checkouts/list-checkout-sessions

get /checkouts
Retrieves a list of checkout sessions for a store with optional filtering by status. Supports pagination.

**Usage:** Analyze all checkout sessions to monitor activities and trends in your store.



# Retrieve Checkout Link
Source: https://docs.blink.store/api-reference/checkouts/retrieve-checkout-link

get /checkout-links/{id}



# Retrieve checkout session details
Source: https://docs.blink.store/api-reference/checkouts/retrieve-checkout-session-details

get /checkouts/{id}
Fetches the status and details of a specific Blink checkout session using its ID. The session details include URL, status, payment status, customer email, etc.

**Usage:** Use this endpoint to review the status of a checkout session and get necessary details for follow-up actions.



# Update Checkout Link
Source: https://docs.blink.store/api-reference/checkouts/update-checkout-link

patch /checkout-links/{id}



# Create Blink Billing Portal Session
Source: https://docs.blink.store/api-reference/customer-portal/create-blink-billing-portal-session

post /portal/sessions
Creates a Stripe billing portal session. Note: This endpoint does not take a request body because the customer ID is derived from the required Customer Bearer token (JWT).



# List Customer Orders
Source: https://docs.blink.store/api-reference/customer-portal/list-customer-orders

get /portal/orders
Fetches orders securely for a specific customer authenticated via portal magic link.

**Usage:** Headless apps building completely custom 'My Account' or 'Order History' pages for their buyers.



# List Customer Subscriptions
Source: https://docs.blink.store/api-reference/customer-portal/list-customer-subscriptions

get /portal/subscriptions
Fetches active and inactive subscriptions securely for an authenticated customer.



# List deliverables (Customer Portal)
Source: https://docs.blink.store/api-reference/customer-portal/list-deliverables-customer-portal

get /portal/orders/{id}/deliverables
Retrieves the complete fulfillment payload for an order, authenticated via the Customer Portal JWT. This allows buyers to securely access their downloads, license keys, and Discord roles directly from the frontend without routing through your custom backend.

**Usage:** You are rendering a 'My Purchases' page in React and want to fetch the buyer's files directly from the browser using their session token.



# Create a customer
Source: https://docs.blink.store/api-reference/customers/create-a-customer

post /customers
Manually creates a new customer record in the store, useful for customer onboarding and creating customer profiles manually.



# Create a customer portal session
Source: https://docs.blink.store/api-reference/customers/create-a-customer-portal-session

post /customers/{id}/portal-session
Generates a 15-minute magic link that logs the customer into their order portal. Use this endpoint to provide customers with quick access to view and manage their orders.



# List customer entitlements
Source: https://docs.blink.store/api-reference/customers/list-customer-entitlements

get /customers/{id}/entitlements
Retrieve the active entitlements (feature flags) granted to a customer based on their active orders and subscriptions.



# List customer orders
Source: https://docs.blink.store/api-reference/customers/list-customer-orders

get /customers/{id}/orders
Retrieves a list of orders made by a specific customer. Includes information such as order status, amount, and product details.

**Usage:** Use this endpoint to manage customer relationships and analyze buying patterns.



# List customer subscriptions
Source: https://docs.blink.store/api-reference/customers/list-customer-subscriptions

get /customers/{id}/subscriptions
Retrieves all active subscriptions for a given customer. Useful for determining current and past engagements with customers.



# List customers
Source: https://docs.blink.store/api-reference/customers/list-customers

get /customers
Fetches a list of customers for a store with optional filters by email and status. Supports pagination to handle large data sets effectively.



# Retrieve customer details
Source: https://docs.blink.store/api-reference/customers/retrieve-customer-details

get /customers/{id}
Fetches full details of a specific customer, including name, email, status, total orders, and lifetime revenue.



# Retrieve customer meter balances
Source: https://docs.blink.store/api-reference/customers/retrieve-customer-meter-balances

get /customers/{id}/meter-balance
Provides the balance of credits for each meter associated with a customer. Meters track specific activities or resources, and this endpoint shows how much credit remains.

**Usage:** Useful for analyzing customer usage and planning billing adjustments, if applicable.



# Update customer details
Source: https://docs.blink.store/api-reference/customers/update-customer-details

patch /customers/{id}
Updates a customer's details such as name, email, or status. Use this endpoint to modify customer records in the database.



# Delete deliverable
Source: https://docs.blink.store/api-reference/deliverables/delete-deliverable

delete /deliverables/{id}
Deletes a file by its ID after ensuring ownership via `x-store-id`. This action is irreversible and should be used with caution. It checks if the file exists and belongs to the correct store before deletion.



# Generate download URL
Source: https://docs.blink.store/api-reference/deliverables/generate-download-url

get /deliverables/{id}/download
Generates a time-limited pre-signed URL for downloading a specific file.



# Get deliverable
Source: https://docs.blink.store/api-reference/deliverables/get-deliverable

get /deliverables/{id}
Fetch detailed information about a file by its ID. This endpoint requires the `x-store-id` in the headers to verify ownership. Successfully retrieves information such as file title, description, URL, and creation date. Useful for accessing and managing deliverables associated with specific products or variants.



# List deliverables
Source: https://docs.blink.store/api-reference/deliverables/list-deliverables

get /deliverables
Retrieve a list of files (deliverables) associated with a store, filtered optionally by product or variant ID. The endpoint supports pagination and requires a valid `x-store-id` in the headers for authentication.



# Upload a deliverable
Source: https://docs.blink.store/api-reference/deliverables/upload-a-deliverable

post /deliverables



# Create a new discount
Source: https://docs.blink.store/api-reference/discounts/create-a-new-discount

post /discounts
Creates a new discount for the store. Ensures unique discount code within the store.



# Delete a discount
Source: https://docs.blink.store/api-reference/discounts/delete-a-discount

delete /discounts/{id}
Deletes a discount from the database. This is irreversible and should be used when the discount is no longer needed.



# List discounts
Source: https://docs.blink.store/api-reference/discounts/list-discounts

get /discounts
Retrieves a list of discounts for a store with optional filtering by status. Supports pagination.



# Retrieve discount details
Source: https://docs.blink.store/api-reference/discounts/retrieve-discount-details

get /discounts/{id}
Fetches details of a specific discount by its ID including code, type, and associated products.



# Update discount details
Source: https://docs.blink.store/api-reference/discounts/update-discount-details

patch /discounts/{id}
Updates information for a specific discount, such as code, amount, or expiration date. Use to edit existing discount offers.



# List Blink disputes
Source: https://docs.blink.store/api-reference/disputes/list-blink-disputes

get /disputes
Fetches a list of disputes associated with the store's connected Blink account. Supports limiting results.



# Embedded Checkout
Source: https://docs.blink.store/api-reference/embedded-checkout

Integrate Blink's embedded overlay checkout programmatically in your application.

To use the embedded checkout on your custom website or web app, you need to include our embed script and use the provided JavaScript API. This allows you to keep users in context and reduce friction.

## **1. Add the Embed Script**

Include the following script tag anywhere in your HTML (preferably right before the closing body tag):

```html theme={null}
<script src="https://js.blink.store/embed.js"></script>
```

<Note>
  **Modern Frameworks (React, Next.js, etc.)**
  If you are using a modern SPA framework like Next.js, do not use a raw HTML `<script>` tag. Instead, use your framework's built-in script loader (e.g., `import Script from 'next/script'` and `<Script src="https://js.blink.store/embed.js" strategy="afterInteractive" />`) to ensure the script loads reliably across client-side navigations.
</Note>

## **2. Using the JavaScript API**

Once the script is loaded, it automatically binds to any clickable element with the class `blink-button`.

### **Automatic Binding (HTML)**

```html theme={null}
<a href="https://yourstore.blink.store/product-slug" class="blink-button">Buy Now</a>
```

### **Programmatic Binding (React / Next.js)**

If you are building a Single Page Application (SPA) where you need to trigger the checkout programmatically, the script exposes a global `window.Blink` object:

```javascript theme={null}
// Trigger the checkout overlay manually
window.Blink.openCheckout('https://yourstore.blink.store/product-slug');

// Close the overlay manually
window.Blink.closeCheckout();
```

### **Advanced Options (Theme Auto-Detection)**

By default, the embedded checkout will automatically detect the host website's theme (light or dark mode) and apply the correct backdrop and checkout UI seamlessly. This overrides the store's default "Overlay Theme Mode" setting.

If you want to manually force a specific theme, or disable auto-detection, you can pass an `options` object:

```javascript theme={null}
// Force dark mode
window.Blink.openCheckout('https://...', { theme: 'dark' });

// Force light mode
window.Blink.openCheckout('https://...', { theme: 'light' });

// Disable auto-detection (respects the store's default setting)
window.Blink.openCheckout('https://...', { theme: 'none' });
```

<Note>
  When generating the checkout URL dynamically via the API (`POST /v1/checkouts`), ensure you pass `"options": { "layout": "overlay" }` in the payload. Our `embed.js` script will automatically handle formatting the URL correctly to trigger the embed mode.
</Note>


# Create Geo-Pricing Rule
Source: https://docs.blink.store/api-reference/geo-pricing/create-geo-pricing-rule

post /geo-pricing
Automatically sets up localized pricing overrides for specific countries.

**Usage:** Global gaming studios deploying a script to adjust virtual currency prices dynamically across 50+ countries based on local inflation.



# List Geo-Pricing Rules
Source: https://docs.blink.store/api-reference/geo-pricing/list-geo-pricing-rules

get /geo-pricing
Lists purchasing power parity (PPP) and strict geo-pricing rules.



# API Overview
Source: https://docs.blink.store/api-reference/introduction

Base URLs, authentication, pagination, rate limits, and an overview of our APIs.

<Warning>
  If you run into any issues, report them to [support@blink.store](mailto:support@blink.store) and we’ll fix them right away.
</Warning>

Welcome to the Blink API! Our suite of APIs provides everything you need to build, manage, and scale your storefront programmatically.

<CardGroup>
  <Card title="Core API" icon="server">
    The main server-to-server API for merchants to manage checkouts, products, deliverables, and store settings.
  </Card>

  <Card title="Financials API" icon="dollar-sign">
    Manage the money side of your business, including invoices, taxes, refunds, disputes, and payouts.
  </Card>

  <Card title="Growth & Marketing API" icon="chart-line">
    Powerful endpoints for cart recovery, discounts, affiliates, splits, and geo-pricing.
  </Card>

  <Card title="Webhooks & Events" icon="webhook">
    Event tracking and webhook management to keep your external systems perfectly in sync.
  </Card>
</CardGroup>

## Base URLs

The Blink API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

<CardGroup>
  <Card title="Production Base URL" icon="globe">
    `https://api.blink.store/v1`
  </Card>
</CardGroup>

<Info>
  **Test Mode**: Blink does not use a separate Sandbox URL. Instead, we offer a unified **Test Mode**. All API requests made using a test-mode secret key are completely isolated from your production data. Learn more in our [Test Mode](/api-reference/test-mode) guide.
</Info>

## Authentication

Blink uses Merchant Secret Keys to authenticate your requests.

### Merchant Secret Keys

For server-to-server interactions, authenticate requests using your Store Secret Key. You can view and manage your API keys in the Blink Dashboard. **Do not share your secret API keys in publicly accessible areas such as GitHub, or client-side code.**

Authentication to the API is performed via HTTP Bearer Auth. In addition to the Bearer token, **all requests must include the `x-store-id` header** to specify which store you are interacting with.

```bash theme={null}
Authorization: Bearer blink_live_xxxxxxxxxxxxxxxxxxxxxxxxxxx
x-store-id: str_xxxxxxxxxxxxxxxxxxxxxxxxxxx
```

<Warning>
  All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
</Warning>

## Pagination

All top-level API resources have support for bulk fetches via "list" API methods. These list API methods share a common pagination structure. Blink uses offset-based pagination via the `page` and `limit` query parameters.

### Query Parameters

| Parameter | Type      | Default | Description                                        |
| :-------- | :-------- | :------ | :------------------------------------------------- |
| `page`    | `integer` | `1`     | The page number to retrieve.                       |
| `limit`   | `integer` | `50`    | The number of items to return per page. Max `100`. |

### Response Format

A paginated response will always wrap the results in a `data` array and include a `meta` object containing pagination details.

```json Paginated Response theme={null}
{
  "meta": {
    "total": 1240,
    "page": 1,
    "limit": 50,
    "has_more": true
  },
  "data": [
    {
      "id": "ord_123",
      "amount": 5000,
      "status": "paid"
    }
  ]
}
```

## Rate Limits

To prevent abuse, Blink limits the number of API requests you can make in a given timeframe.

* **Rate Limit**: 100 requests per second

If you exceed these limits, the API will return a `429 Too Many Requests` status code.


# Download Invoice PDF
Source: https://docs.blink.store/api-reference/invoices/download-invoice-pdf

get /invoices/{id}/pdf
Generates and downloads a secure PDF receipt of the invoice.

**Usage:** Enterprise agencies building custom portals where B2B clients can download their tax-compliant PDF receipts on demand.



# List all invoices
Source: https://docs.blink.store/api-reference/invoices/list-all-invoices

get /invoices
Returns a paginated list of all invoices generated by subscriptions or manual billing.



# List subscription invoices
Source: https://docs.blink.store/api-reference/invoices/list-subscription-invoices

get /subscription-invoices
Fetches a list of subscription invoices for the store. Supports filtering by status, subscription ID, and customer ID. Supports pagination.

**Usage:** Useful for tracking and managing subscription invoices and financial records.



# Retrieve an invoice
Source: https://docs.blink.store/api-reference/invoices/retrieve-an-invoice

get /invoices/{id}
Retrieves details of a specific invoice.



# Activate a License Key
Source: https://docs.blink.store/api-reference/license-keys/activate-a-license-key

post /license-keys/activate
Activates a license key by incrementing its activation count, performing validation checks for key status, expiration, and activation limits. Requires `x-store-id` and `license_key` in the request body.

Activate a license key for a specific device or machine instance. This endpoint increments the active instances count and returns a unique `instance_id`.

This endpoint is **Client-Safe**. You do not need to provide your `blnk_live_` secret key. You can call this directly from a desktop application (like Electron, Tauri, or Swift) by simply providing the `license_key` and an optional `instance_name`.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://api.blink.store/v1/license-keys/activate \
    --header 'Content-Type: application/json' \
    --data '{
      "license_key": "YOUR_LICENSE_KEY_STRING",
      "instance_name": "Omar'\''s MacBook Pro",
      "product_id": "OPTIONAL_PRODUCT_ID"
    }'
  ```

  ```javascript JavaScript theme={null}
  fetch("https://api.blink.store/v1/license-keys/activate", {
    method: "POST",
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "license_key": "YOUR_LICENSE_KEY_STRING",
      "instance_name": "Omar's MacBook Pro",
      "product_id": "OPTIONAL_PRODUCT_ID"
    })
  })
  .then(response => response.json())
  .then(data => console.log(data));
  ```
</RequestExample>


# Bulk import license keys
Source: https://docs.blink.store/api-reference/license-keys/bulk-import-license-keys

post /license-keys/import
Programmatically migrate external license keys into Blink.



# Create license key manually
Source: https://docs.blink.store/api-reference/license-keys/create-license-key-manually

post /license-keys



# Deactivate a License Key
Source: https://docs.blink.store/api-reference/license-keys/deactivate-a-license-key

post /license-keys/deactivate

Deactivate a specific machine instance for a given license key. This frees up an activation slot, allowing the customer to activate the license on a new device.

This endpoint is **Client-Safe**. You do not need to provide your `blnk_live_` secret key. You can call this directly from a desktop application (like Electron, Tauri, or Swift) by simply providing the `license_key` and the `instance_id`.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://api.blink.store/v1/license-keys/deactivate \
    --header 'Content-Type: application/json' \
    --data '{
      "license_key": "YOUR_LICENSE_KEY_STRING",
      "instance_id": "INSTANCE_UUID"
    }'
  ```

  ```javascript JavaScript theme={null}
  fetch("https://api.blink.store/v1/license-keys/deactivate", {
    method: "POST",
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "license_key": "YOUR_LICENSE_KEY_STRING",
      "instance_id": "INSTANCE_UUID"
    })
  })
  .then(response => response.json())
  .then(data => console.log(data));
  ```
</RequestExample>


# List license keys
Source: https://docs.blink.store/api-reference/license-keys/list-license-keys

get /license-keys
Retrieves a list of license keys for the store with optional filtering by status, product ID, or order ID. Supports pagination.

**Usage:** Useful for managing license keys issued to customers, including monitoring their status and usage.



# Retrieve license key details
Source: https://docs.blink.store/api-reference/license-keys/retrieve-license-key-details

get /license-keys/{id}
Fetch complete details of a license key using its ID, including status, activations, product, and customer information. Requires `x-store-id` for authentication and confirmation of ownership.



# Revoke a license key
Source: https://docs.blink.store/api-reference/license-keys/revoke-a-license-key

post /license-keys/{id}/revoke
Permanently disable a license key to prevent further use. Requires `x-store-id` for verification and checks the key’s status before revocation. Suitable when a license has been compromised or needs termination.



# Update license key details
Source: https://docs.blink.store/api-reference/license-keys/update-license-key-details

patch /license-keys/{id}
Allows updating of specific fields in a license key such as expiration date, activation limit, or status. Requires `x-store-id` for validation.



# Validate a License Key
Source: https://docs.blink.store/api-reference/license-keys/validate-a-license-key

post /license-keys/validate
Validates a license key's status, expiration, and activation limits.

**Usage:** Ensures license keys are active and have not reached their usage or expiration limits before they are used.

Validate a license key and optionally verify if a specific machine instance is still active.

This endpoint is **Client-Safe**. You do not need to provide your `blnk_live_` secret key. You can call this directly from a desktop application (like Electron, Tauri, or Swift) by simply providing the `license_key` and an optional `instance_id`.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://api.blink.store/v1/license-keys/validate \
    --header 'Content-Type: application/json' \
    --data '{
      "license_key": "YOUR_LICENSE_KEY_STRING",
      "instance_id": "OPTIONAL_INSTANCE_UUID",
      "product_id": "OPTIONAL_PRODUCT_ID"
    }'
  ```

  ```javascript JavaScript theme={null}
  fetch("https://api.blink.store/v1/license-keys/validate", {
    method: "POST",
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "license_key": "YOUR_LICENSE_KEY_STRING",
      "instance_id": "OPTIONAL_INSTANCE_UUID",
      "product_id": "OPTIONAL_PRODUCT_ID"
    })
  })
  .then(response => response.json())
  .then(data => console.log(data));
  ```
</RequestExample>


# Create a new meter
Source: https://docs.blink.store/api-reference/meters/create-a-new-meter

post /meters
Adds a new meter for tracking a specific event or resource.

**Usage:** Essential for tracking new metrics in order to better understand usage and performance trends within the store.



# List all meters
Source: https://docs.blink.store/api-reference/meters/list-all-meters

get /meters
Retrieves a list of all meters within a store, with options for pagination.

**Usage:** Provides a comprehensive view of all meters being tracked, helping in resource management and strategy planning.



# List usage records
Source: https://docs.blink.store/api-reference/meters/list-usage-records

get /usage-records



# Retrieve Customer Balance
Source: https://docs.blink.store/api-reference/meters/retrieve-customer-balance

get /balances
Fetches the current real-time prepaid credit balance for a customer.

**Usage:** AI tools displaying 'Credits Remaining: 500' in their app header.



# Retrieve meter details
Source: https://docs.blink.store/api-reference/meters/retrieve-meter-details

get /meters/{id}
Fetches specific details of a meter identified by its ID.

**Usage:** Allows store owners to view and manage the measurement metrics tied to particular activities or resources within their store.



# Update meter details
Source: https://docs.blink.store/api-reference/meters/update-meter-details

patch /meters/{id}
Updates the details of a specific meter, such as name or unit.

**Usage:** Modify meter configurations to ensure accurate tracking or reporting of metrics.



# Retrieve metrics for revenue, orders, and subscriptions
Source: https://docs.blink.store/api-reference/metrics/retrieve-metrics-for-revenue-orders-and-subscriptions

get /metrics
Provides statistics for revenue, orders, subscriptions, and customer counts within a given date range.

**Usage:** Use to derive insights into sales performance and customer growth over times specific periods.



# Issue a refund
Source: https://docs.blink.store/api-reference/orders/issue-a-refund

post /orders/{id}/refund
Programmatically issue a full or partial refund for an order.

**Usage:** Headless event organizers managing bulk ticket cancellations directly from their custom admin panel without logging into Blink.



# List all deliverables for an order
Source: https://docs.blink.store/api-reference/orders/list-all-deliverables-for-an-order

get /orders/{id}/deliverables
Retrieves the complete fulfillment payload for a specific order. This is the ultimate fulfillment endpoint for custom storefronts. It automatically generates 1-hour secure pre-signed URLs for any file downloads, fetches any License Keys auto-generated during checkout, and returns dynamic claim URLs for Discord integrations.

**Usage:** A company building a custom 'My Library' or 'All Access' dashboard where buyers log in to access their purchased goods securely.



# List all orders
Source: https://docs.blink.store/api-reference/orders/list-all-orders

get /orders
Fetches a paginated list of all orders.

**Usage:** Build a custom seller dashboard or sync orders to an external ERP/CRM system automatically.



# Resend automatic fulfillment receipt
Source: https://docs.blink.store/api-reference/orders/resend-automatic-fulfillment-receipt

post /orders/{id}/deliverables/resend
Programmatically triggers Blink's automatic fulfillment email to the buyer of this order. This email contains their secure download links, license keys, and order receipt.

**Usage:** A seller with a custom support dashboard wants to build a one-click 'Resend Receipt' button for their customer support team when a buyer says they didn't receive their email.



# Retrieve an order
Source: https://docs.blink.store/api-reference/orders/retrieve-an-order

get /orders/{id}
Fetches detailed information for a specific order, including customer info and paid amounts.



# Add a member to an organization
Source: https://docs.blink.store/api-reference/organizations/add-a-member-to-an-organization

post /organizations/{id}/members



# Create a new organization
Source: https://docs.blink.store/api-reference/organizations/create-a-new-organization

post /organizations
Creates a new organization within the store using `x-store-id`. Requires `email` and `organization_name`. Optionally accepts `billing_email`, defaulting to the provided `email` if not supplied.

**Usage:** Useful for adding new organizational entities to be associated with your store.



# Delete an organization
Source: https://docs.blink.store/api-reference/organizations/delete-an-organization

delete /organizations/{id}



# List all organizations
Source: https://docs.blink.store/api-reference/organizations/list-all-organizations

get /organizations
Fetches a list of organizations associated with the store identified by `x-store-id`. Supports pagination with `limit` and `page` query parameters. Each organization includes details such as email, organization name, and billing email.

**Usage:** Useful for managing and analyzing organizations linked to your store.



# List Organization Members
Source: https://docs.blink.store/api-reference/organizations/list-organization-members

get /organizations/{id}/members



# Remove Organization Member
Source: https://docs.blink.store/api-reference/organizations/remove-organization-member

delete /organizations/{id}/members/{member_id}



# Retrieve Organization
Source: https://docs.blink.store/api-reference/organizations/retrieve-organization

get /organizations/{id}



# Update Organization
Source: https://docs.blink.store/api-reference/organizations/update-organization

patch /organizations/{id}



# Initialize Payee Profile
Source: https://docs.blink.store/api-reference/payees/initialize-payee-profile

post /v1/payees
Generates a secure Stripe Connect onboarding link for a headless user. Handles the creation of the underlying Stripe Express account.



# Retrieve Payee Status
Source: https://docs.blink.store/api-reference/payees/retrieve-payee-status

get /v1/payees/{id}
Fetches the onboarding status of a payee to determine if they can receive payouts.



# List Blink payouts
Source: https://docs.blink.store/api-reference/payouts/list-blink-payouts

get /payouts
Fetches a list of Blink payouts for the store identified by `x-store-id`. Requires a connected Blink account. Supports limiting the result set.

**Usage:** Useful for financial reconciliation and tracking payouts from Blink.



# Retrieve a payout
Source: https://docs.blink.store/api-reference/payouts/retrieve-a-payout

get /v1/payouts/{id}
Retrieves the details of an existing payout.



# Archive a product
Source: https://docs.blink.store/api-reference/products/archive-a-product

delete /products/{id}
Archives a product by setting its status to 'archived'. This action does not delete the product but prevents it from being sold. Requires `x-store-id`.

**Usage:** Utilized when a product should be temporarily or permanently withdrawn from active sale while keeping its configuration for historical or analytical purposes.

**Path



# Create a new product
Source: https://docs.blink.store/api-reference/products/create-a-new-product

post /products
Creates a new product in the store. Requires detailed product information including name, pricing model, and price. Optionally includes settings for subscription intervals, trial days, and license key configurations.

**Usage:** Adds new products to the store's offerings, supporting different pricing models and configurations.



# Create a new product variant
Source: https://docs.blink.store/api-reference/products/create-a-new-product-variant

post /products/{id}/variants
Adds a new variant to a product. Requires `name` and `price`, along with other optional parameters. Requires `x-store-id`.

**Usage:** Valuable for expanding a product's options, such as adding new sizes or colors to a clothing product.

**Path



# Delete a product variant
Source: https://docs.blink.store/api-reference/products/delete-a-product-variant

delete /products/{id}/variants/{variantId}
Deletes a specific product variant. This action is irreversible. Requires `x-store-id`.

**Usage:** Suitable for removing specific variant options from a product's offering.

**Path



# List all products
Source: https://docs.blink.store/api-reference/products/list-all-products

get /products
Retrieves a list of all products associated with a specific store. Supports pagination and filtering by status and pricing model. This endpoint provides detailed product information including variants and images.

**Usage:** Useful for managing the store's product catalog and reviewing available inventory.



# List product variants
Source: https://docs.blink.store/api-reference/products/list-product-variants

get /products/{id}/variants
Retrieve a list of all variants associated with a specific product. Requires `x-store-id`.

**Usage:** Useful for detailed inventory management and displaying all available options for a product.

**Path



# Retrieve product details
Source: https://docs.blink.store/api-reference/products/retrieve-product-details

get /products/{id}
Fetches detailed information about a product, including variants and deliverables, for a given product ID. Requires `x-store-id`.

**Usage:** Provides comprehensive insights into a product's configuration, variants, and linked digital deliverables for store management and product cataloging.

**Path



# Retrieve product variant details
Source: https://docs.blink.store/api-reference/products/retrieve-product-variant-details

get /products/{id}/variants/{variantId}
Fetches detailed information about a specific product variant. Requires `x-store-id`.

**Usage:** Provides comprehensive insights into a variant's configuration for inventory management and display purposes.

**Path



# Update product details
Source: https://docs.blink.store/api-reference/products/update-product-details

patch /products/{id}
Updates an existing product's attributes such as name, price, or status. A product ID is required. Requires `x-store-id`.

**Usage:** Suitable for modifying product listings directly in the store's catalog, allowing for dynamically adjusting product offerings.

**Path



# Update product variant details
Source: https://docs.blink.store/api-reference/products/update-product-variant-details

patch /products/{id}/variants/{variantId}
Updates attributes for a specific product variant, such as name, price, or status. Requires `x-store-id`.

**Usage:** Useful for maintaining variant accuracy and availability within the store catalog.

**Path



# List refunds
Source: https://docs.blink.store/api-reference/refunds/list-refunds

get /refunds
Retrieves a list of refunds associated with a store's connected Blink account. Supports limiting the results.

**Usage:** Useful for financial reconciliation and tracking refund activities within the store.



# Create a split
Source: https://docs.blink.store/api-reference/splits/create-a-split

post /splits
Creates a new revenue split and automatically invites the recipients.



# Delete a split
Source: https://docs.blink.store/api-reference/splits/delete-a-split

delete /splits/{id}
Permanently deletes a revenue split.



# List splits
Source: https://docs.blink.store/api-reference/splits/list-splits

get /splits
Returns a paginated list of revenue splits for the store.



# Retrieve a split
Source: https://docs.blink.store/api-reference/splits/retrieve-a-split

get /splits/{id}
Retrieves the details of an existing revenue split.



# Update a split
Source: https://docs.blink.store/api-reference/splits/update-a-split

patch /splits/{id}
Updates the specified split. When updating the recipients or products array, the entire array is replaced with the newly provided one.



# Update a subscription invoice
Source: https://docs.blink.store/api-reference/subscription-invoices/update-a-subscription-invoice

patch /subscription-invoices/{id}



# Create a subscription manually
Source: https://docs.blink.store/api-reference/subscriptions/create-a-subscription-manually

post /subscriptions
Manually create a subscription for a customer. This bypasses checkout and directly assigns the subscription.



# List subscriptions
Source: https://docs.blink.store/api-reference/subscriptions/list-subscriptions

get /subscriptions
Retrieves a list of all subscriptions for a given store. Supports filtering by status, customer ID, and product ID. Includes pagination.

**Usage:** Useful for managing and analyzing all active and past subscriptions.



# Preview a subscription swap
Source: https://docs.blink.store/api-reference/subscriptions/preview-a-subscription-swap

get /subscriptions/{id}/preview-swap
Preview the prorated invoice amounts for a potential subscription swap.



# Retrieve subscription details
Source: https://docs.blink.store/api-reference/subscriptions/retrieve-subscription-details

get /subscriptions/{id}
Fetches detailed information about a specific subscription. Includes product and variant details associated with the subscription.

**Usage:** Useful for understanding customer subscriptions and managing their lifecycle.

**Path



# Retrieve subscription invoice
Source: https://docs.blink.store/api-reference/subscriptions/retrieve-subscription-invoice

get /subscription-invoices/{id}



# Update or swap a subscription
Source: https://docs.blink.store/api-reference/subscriptions/update-or-swap-a-subscription

patch /subscriptions/{id}
Updates the status of a subscription, allowing actions such as cancelation, immediate cancelation, resumption, or executing a **swap** (upgrade/downgrade). To execute a swap, set `action` to `swap` and provide `variant_id` or `product_id` in the body.



# Calculate Taxes Dynamically
Source: https://docs.blink.store/api-reference/taxes/calculate-taxes-dynamically

post /taxes/calculate
Calculates precise digital tax rates based on the buyer's IP and billing address before charging them.

**Usage:** Hybrid hardware/software companies building 100% custom checkout flows that need to show real-time tax line items to the user before they click 'Pay'.



# Validate VAT Number
Source: https://docs.blink.store/api-reference/taxes/validate-vat-number

post /taxes/validate-vat
Validates an EU VAT or international tax ID via the VIES network to automatically apply reverse-charge exemptions.



# Test Mode
Source: https://docs.blink.store/api-reference/test-mode

Learn how to use test mode to safely build and test your integration without affecting live data.

Blink provides a dedicated **Test Mode** to help you build, experiment, and verify your integration safely before going live. When Test Mode is active, all dashboard metrics, orders, customers, and events are strictly sandboxed.

## Toggling Test Mode

You can toggle Test Mode globally from your Blink dashboard.

1. Open the sidebar navigation.
2. At the bottom, locate the **Test Mode** toggle right above your active store selector.
3. Turn the switch **ON**.
4. You'll see a global orange banner appear at the top of the dashboard indicating that you are now viewing and interacting with simulated test data.

## API Keys in Test Mode

Blink provides two sets of API keys (Access Tokens) for each store depending on your mode:

* **Live Keys:** `blnk_live_...`
* **Test Keys:** `blnk_test_...`

To generate a test key, simply toggle Test Mode to ON in your dashboard (orange banner) before creating a new Access Token. It will be generated with a `blnk_test_` prefix. To perform test operations via the API, simply use your `blnk_test_` keys. Test mode API calls will generate test data (like test orders and customers) that are only visible in your dashboard when the global Test Mode toggle is ON.

## Using the Shopper API in Test Mode

If you're using the Shopper API or building a custom storefront, ensure that you pass the `blnk_test_...` key to your frontend client. Any checkouts generated using the test key will automatically use Stripe's test environment, allowing you to use [Stripe's test cards](https://docs.stripe.com/testing) to simulate successful or failed payments.

## Test Mode Sandboxing Rules

When the dashboard is in Test Mode, the following rules apply:

* **Products:** Your product catalog is completely isolated between live and test modes. Any products created while in Test Mode will not appear on your live storefront, and live products are hidden while testing.
* **Analytics & Overview:** Revenue, MRR, conversion rates, and sales data are recalculated using only test volume.
* **Orders & Transactions:** Only test purchases, refunds, and failed checkout attempts are shown.
* **Customers & Subscriptions:** Only customers and subscriptions created via test API keys or test checkouts are visible.
* **Discounts:** Any coupons you create while Test Mode is ON are flagged as test coupons. They will not be accepted in live checkouts.
* **Payouts:** The Payouts dashboard will display a `$0` empty state, as payouts are not processed for test transactions.
* **Webhooks:** Webhook endpoints are strictly separated by mode. When creating an endpoint, it's assigned to your current mode. Test webhooks will only receive test events.


# Claim an upsell offer
Source: https://docs.blink.store/api-reference/upsells/claim-an-upsell-offer

post /upsells/{id}/claim
Processes the off-session charge for an accepted upsell using the original order's payment intent. This automatically provisions deliverables and assigns them to the original order.



# List all store upsells
Source: https://docs.blink.store/api-reference/upsells/list-all-store-upsells

get /upsells
Returns a paginated list of all upsells for the authenticated store.



# Retrieve triggered upsells
Source: https://docs.blink.store/api-reference/upsells/retrieve-triggered-upsells

get /products/{id}/upsells
Fetches the active upsells configured to trigger when the specified product is purchased.



# Retrieve upsell performance
Source: https://docs.blink.store/api-reference/upsells/retrieve-upsell-performance

get /upsells/{id}/performance
Retrieves the core metrics (sales, revenue, views, declines) for a specific upsell.



# Track an upsell event
Source: https://docs.blink.store/api-reference/upsells/track-an-upsell-event

post /upsells/{id}/events
Record a telemetry event (view or decline) when an upsell is presented on a custom frontend. This ensures accurate conversion metrics.



# Verify Webhook Signatures
Source: https://docs.blink.store/api-reference/verify-webhook-signatures

Learn how to verify that webhook events were sent by Blink.

Blink securely signs all webhook events it sends to your endpoints. This ensures that the payloads you receive are actually from Blink and have not been tampered with by a third party.

You should always verify webhook signatures before processing them in your application.

## The Signature Header

When Blink sends a webhook to your server, it includes the following headers:

* `Blink-Signature`: The cryptographic signature of the payload (e.g., `v1=a1b2c3d4...`)
* `Blink-Timestamp`: The unix timestamp (in seconds) when the event was dispatched.
* `Blink-Event`: The name of the event (e.g., `order.paid`).

## How to Verify the Signature

Blink uses HMAC with SHA-256 to sign webhook payloads. To verify the signature, you need the **Signing Secret** for your webhook endpoint (which you can find in the Blink dashboard or via the API).

Follow these steps to verify the signature:

1. **Extract the timestamp and signature** from the headers.
2. **Prepare the signed payload string** by concatenating the timestamp, a dot (`.`), and the raw JSON request body: `${timestamp}.${rawBody}`.
3. **Compute the expected HMAC signature** using SHA-256, your signing secret, and the signed payload string.
4. **Compare the signatures**. If your computed signature matches the one in the `Blink-Signature` header (stripping the `v1=` prefix), the webhook is valid!

### Example: Node.js (Express)

Here is a complete example of how to verify a webhook signature in a Node.js Express application:

```javascript theme={null}
const express = require('express');
const crypto = require('crypto');

const app = express();

// The raw body is required to compute the signature correctly.
app.post('/webhook', express.raw({ type: 'application/json' }), (req, res) => {
  const signatureHeader = req.headers['blink-signature'];
  const timestamp = req.headers['blink-timestamp'];
  const webhookSecret = 'whsec_your_signing_secret_here';

  if (!signatureHeader || !timestamp) {
    return res.status(400).send('Missing webhook headers');
  }

  // Extract the actual signature hash from the v1= prefix
  const signature = signatureHeader.replace('v1=', '');

  // 1. Prepare the payload string
  const payloadToSign = `${timestamp}.${req.body.toString('utf8')}`;

  // 2. Compute the HMAC SHA-256 signature
  const expectedSignature = crypto
    .createHmac('sha256', webhookSecret)
    .update(payloadToSign)
    .digest('hex');

  // 3. Compare the signatures securely
  if (crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expectedSignature))) {
    console.log('✅ Webhook signature verified!');
    
    // Parse the body and process the event
    const event = JSON.parse(req.body.toString('utf8'));
    console.log(`Received event: ${event.event}`);
    
    res.status(200).send('OK');
  } else {
    console.error('❌ Invalid webhook signature');
    res.status(401).send('Invalid signature');
  }
});

app.listen(3000, () => console.log('Listening on port 3000'));
```

### Example: Next.js (App Router)

If you are using Next.js App Router, you can verify webhooks like this:

```typescript theme={null}
import { NextResponse } from 'next/server';
import crypto from 'crypto';

export async function POST(req: Request) {
  const signatureHeader = req.headers.get('blink-signature');
  const timestamp = req.headers.get('blink-timestamp');
  const webhookSecret = process.env.BLINK_WEBHOOK_SECRET!;

  if (!signatureHeader || !timestamp) {
    return NextResponse.json({ error: 'Missing headers' }, { status: 400 });
  }

  const signature = signatureHeader.replace('v1=', '');
  const rawBody = await req.text();
  const payloadToSign = `${timestamp}.${rawBody}`;

  const expectedSignature = crypto
    .createHmac('sha256', webhookSecret)
    .update(payloadToSign)
    .digest('hex');

  if (signature !== expectedSignature) {
    return NextResponse.json({ error: 'Invalid signature' }, { status: 401 });
  }

  const event = JSON.parse(rawBody);
  console.log('✅ Verified Event:', event.event);

  return NextResponse.json({ received: true });
}
```

## Replay Attacks

As a best practice to prevent replay attacks, you should check that the `Blink-Timestamp` is within a reasonable tolerance (e.g., 5 minutes) of your server's current time.

## Test vs Live Webhooks

<Warning>
  **Security Best Practice:** A cryptographically verified webhook only proves that the payload was sent by Blink. It does **not** prove that the customer actually paid real money!

  Blink sends webhooks for both **Test** (simulated) purchases and **Live** (real) purchases. An attacker could use a test card on your storefront checkout to trigger a perfectly valid, signed webhook.

  To avoid accidentally giving away your product for free, you must always explicitly check the `mode` parameter in the webhook JSON payload:

  ```json theme={null}
  {
    "event": "order.paid",
    "mode": "live",
    // ...
  }
  ```

  If your integration is in production, you should ignore or drop any webhooks where `mode === 'test'`.
</Warning>


# Webhook Events
Source: https://docs.blink.store/api-reference/webhook-events

A complete reference of all webhook events supported by Blink.

When you register a webhook endpoint, you can subscribe to specific events. Below is the comprehensive list of all events you can listen for across the Blink platform.

<Warning>
  **Security Warning:** Blink sends webhooks for both **Test** (simulated) events and **Live** (real) events. To avoid giving away free products when a customer uses a test credit card, you must explicitly verify that the webhook mode is live (e.g. `is_test: false` or `mode: "live"`) before fulfilling the order.
</Warning>

## Event Payload Structure

All events share a standard wrapper structure. The `data` property contains the specific object related to the event.

```json theme={null}
{
  "event": "order.paid",
  "created_at": "2026-07-28T09:00:00.000Z",
  "data": {
    "id": "ord_12345",
    "amount": 2000,
    "status": "paid",
    "is_test": false,
    "customer": {
      "id": "cus_xyz",
      "name": "Jane Doe",
      "email": "jane@example.com"
    },
    "product": {
      "id": "prod_abc",
      "name": "Premium Plan"
    },
    "entitlements": {
      "pro_tier": "true"
    }
  }
}
```

## Orders

| Event Name       | Description                                  |
| ---------------- | -------------------------------------------- |
| `order.created`  | Fired when a new order is placed.            |
| `order.paid`     | Fired when payment is confirmed on an order. |
| `order.refunded` | Fired when an order is refunded.             |

## Checkouts

| Event Name           | Description                               |
| -------------------- | ----------------------------------------- |
| `checkout.created`   | Fired when a checkout session is created. |
| `checkout.completed` | Fired when a checkout is completed.       |
| `checkout.expired`   | Fired when a checkout session expires.    |

## Audience

| Event Name                  | Description                                     |
| --------------------------- | ----------------------------------------------- |
| `audience.subscriber_added` | Fired when a new subscriber joins the audience. |

## Customers & Seats

| Event Name              | Description                                       |
| ----------------------- | ------------------------------------------------- |
| `customer.created`      | Fired when a new customer record is created.      |
| `customer.updated`      | Fired when customer details are updated.          |
| `customer.seat_added`   | Fired when a seat is assigned to a member.        |
| `customer.seat_removed` | Fired when a seat is removed from a member.       |
| `customer.deleted`      | Fired when a customer is deleted or unsubscribed. |

## Subscriptions

| Event Name                | Description                                                   |
| ------------------------- | ------------------------------------------------------------- |
| `subscription.created`    | Fired when a subscription starts.                             |
| `subscription.active`     | Fired when a subscription becomes active.                     |
| `subscription.updated`    | Fired when a subscription is updated.                         |
| `subscription.canceled`   | Fired when a subscription is canceled.                        |
| `subscription.uncanceled` | Fired when a cancellation is reversed.                        |
| `subscription.past_due`   | Fired when a payment fails, making the subscription past due. |
| `subscription.revoked`    | Fired when a subscription is forcefully ended.                |
| `subscription.upgraded`   | Fired when a subscription is upgraded or downgraded.          |

## Products

| Event Name         | Description                       |
| ------------------ | --------------------------------- |
| `product.created`  | Fired when a product is created.  |
| `product.updated`  | Fired when a product is updated.  |
| `product.archived` | Fired when a product is archived. |
| `bundle.created`   | Fired when a bundle is created.   |
| `bundle.updated`   | Fired when a bundle is updated.   |
| `bundle.archived`  | Fired when a bundle is archived.  |

## Discounts

| Event Name         | Description                       |
| ------------------ | --------------------------------- |
| `discount.created` | Fired when a discount is created. |
| `discount.updated` | Fired when a discount is updated. |
| `discount.deleted` | Fired when a discount is deleted. |

## License Keys

| Event Name            | Description                          |
| --------------------- | ------------------------------------ |
| `license_key.created` | Fired when a license key is issued.  |
| `license_key.revoked` | Fired when a license key is revoked. |

## Affiliates

| Event Name                    | Description                                                      |
| ----------------------------- | ---------------------------------------------------------------- |
| `affiliate.approved`          | Fired when an affiliate application is approved.                 |
| `affiliate.conversion`        | Fired when an affiliate records a conversion.                    |
| `affiliate.commission_earned` | Fired when an affiliate earns commission on a successful payout. |
| `affiliate.payout.processed`  | Fired when an affiliate's balance is transferred via Stripe.     |

## Abandoned Carts

| Event Name                 | Description                                |
| -------------------------- | ------------------------------------------ |
| `abandoned_cart.created`   | Fired when a cart is abandoned.            |
| `abandoned_cart.recovered` | Fired when an abandoned cart is recovered. |

## Organizations

| Event Name             | Description                                  |
| ---------------------- | -------------------------------------------- |
| `organization.created` | Fired when an organization is created.       |
| `organization.updated` | Fired when organization details are updated. |
| `organization.deleted` | Fired when an organization is deleted.       |

## Disputes

| Event Name        | Description                     |
| ----------------- | ------------------------------- |
| `dispute.created` | Fired when a dispute is opened. |
| `dispute.won`     | Fired when a dispute is won.    |
| `dispute.lost`    | Fired when a dispute is lost.   |

## Payouts

| Event Name       | Description                               |
| ---------------- | ----------------------------------------- |
| `payout.created` | Fired when a payout is created.           |
| `payout.paid`    | Fired when a payout is successfully paid. |
| `payout.failed`  | Fired when a payout fails to process.     |

## Refunds

| Event Name       | Description                            |
| ---------------- | -------------------------------------- |
| `refund.created` | Fired when a refund is initiated.      |
| `refund.updated` | Fired when a refund status is updated. |

## Subscription Invoices

| Event Name                            | Description                            |
| ------------------------------------- | -------------------------------------- |
| `subscription_invoice.created`        | Fired when a new invoice is generated. |
| `subscription_invoice.paid`           | Fired when an invoice is paid.         |
| `subscription_invoice.payment_failed` | Fired when an invoice payment fails.   |


# Event Delivery Log
Source: https://docs.blink.store/api-reference/webhooks/event-delivery-log

get /events
Retrieves a list of tracked events for a specific store based on the `x-store-id` header. Supports filtering by event name and pagination.

**Use case:** Useful for auditing and reviewing the events tracked, aiding in performance monitoring and data analysis.

**Query Parameters:**
- `limit` (integer, optional): The maximum number of events to return.
- `event` (string, optional): The name of the event to filter by.

**Responses:**
- **200:** A list of tracked events.




# Track an Event
Source: https://docs.blink.store/api-reference/webhooks/track-an-event

post /events
Tracks a custom event for analytics purposes. Requires the `x-store-id` header for identifying the store. Accepts an `eventName`, `eventData`, `url`, and `referrer`. Utilizes Umami for tracking and groups URLs under the store for Blink's dashboard.

**Use case:** This endpoint allows for tracking custom events for a store, useful in analyzing customer interactions, marketing effectiveness, and performance metrics.

**Request Body:**
- `eventName` (string, required): The name of the event.
- `eventData` (object, optional): Additional data related to the event.

**Responses:**
- **200:** Event tracked successfully.




# Overview
Source: https://docs.blink.store/broadcasts



The **Broadcasts** page is your campaign management hub.

Here you can create, schedule, monitor, and analyze all email campaigns sent from your store.

## **Dashboard Metrics**

### **Sent Broadcasts**

The total number of campaigns that have been sent.

### **Total Revenue**

Revenue generated from email campaigns.

### **Average Open Rate**

The average percentage of recipients who opened your emails.

### **Unsubscribes**

The total number of users who opted out of future emails.

## **Creating a Broadcast**

Click **New Broadcast** to create a campaign.

Blink includes a full-featured visual email builder that allows you to design professional emails without writing code.

### **Email Builder Features**

* Drag-and-drop email editing
* Custom layouts and content blocks
* Product promotions and call-to-action sections
* Mobile-friendly designs
* Save drafts while you work
* Send test emails
* Schedule campaigns
* Send immediately

### **Sending Options**

#### **Save Draft**

Store your campaign for future editing.

#### **Send Test Email**

Preview your campaign in a real inbox before sending.

#### **Schedule**

Choose a future date and time for delivery.

#### **Send Now**

Immediately deliver the campaign to eligible subscribers.

## **Broadcast Statuses**

### **Draft**

The campaign is still being edited and has not been scheduled or sent.

### **Scheduled**

The campaign is queued for future delivery.

### **Sent**

The campaign has been delivered to subscribers.

## **Campaign Performance**

Each broadcast displays:

### **Sent**

The date the campaign was delivered.

### **Opens**

The number and percentage of subscribers who opened the email.

### **Revenue**

Revenue generated from the campaign.

### **Statistics**

For sent campaigns, you can view detailed campaign performance and engagement metrics.


# Bumps
Source: https://docs.blink.store/bumps



Increase your revenue by offering simple add-ons during checkout. Checkout bumps are small, optional extras customers can add to their order with a single click — no friction, no extra steps.

## **Overview**

At the top of the page, you’ll see your bump performance:

**Total Bumps**\
Number of bumps you’ve created.

**Bump Sales**\
How many times bumps were purchased.

**Bump Revenue**\
Total revenue generated from bumps.

***

## **Bumps List**

All your created bumps appear here.

For each bump, you’ll see:

* **Title**
* **Price**
* **Sales** (how many times it was added)
* **Revenue** generated

***

## **Create a Bump**

Click **New Bump** to create an add-on offer.

Bumps are designed to be quick decisions, keep them simple, relevant, and valuable.

***

## **General Settings**

**Badge title**\
A small label that appears above the bump (e.g. “Addon”, “Popular”, “Recommended”).

**Badge color**\
Choose a color to make the badge stand out.

**Title**\
The main name of your bump.\
Example: “6 months support”, “Extended license”

**Description**\
Optional short explanation of what the customer gets.\
Keep it clear and benefit-focused.

**Price**\
How much the bump costs.

***

## **Deliverables (Optional)**

Attach content that customers receive only if they purchase the bump.

You can add:

* **Files** (downloads)
* **Links** (external resources)
* **Custom items** (manual or flexible delivery)

This is perfect for things like:

* Bonus files
* Extra resources
* Extended support
* Private links or access

<Info>
  Learn more about [deliverable types](/add-products)
</Info>

***

## **How Bumps Work**

During checkout, customers will see your bump as an optional add-on.

They can include it instantly with one click,  no page reload, no disruption.

***

## **Best Practices**

Keep bumps:

* **Relevant** — directly related to the product
* **Low friction** — easy yes decision
* **High value** — clearly worth the price

Good examples:

* Extended support
* Bonus content
* Premium version upgrades
* Done-for-you resources

***

## **Why use checkout bumps?**

They’re one of the simplest ways to increase average order value without needing more traffic.

A well-placed bump can significantly boost revenue with minimal effort.


# Cart recovery
Source: https://docs.blink.store/cart-recovery



Manage your cart recovery flow and track how much revenue you’re bringing back from lost checkouts.

**What are abandoned carts?**

An abandoned cart happens when a customer starts the checkout process—adds a product, enters their details, or reaches the payment step—but leaves before completing the purchase.

This can happen for a lot of reasons:

* They’re just browsing or comparing options
* They get distracted or run out of time
* They hesitate on price
* They plan to come back later
* Payment friction or second thoughts

These customers already showed intent. They were close to buying. That’s why recovering them is one of the highest-impact ways to increase revenue without needing new traffic.

**Cart Recovery Performance**\
Quick snapshot of how your recovery system is performing:

**Total Abandoned**\
The number of checkouts that were started but not completed.

**Carts Recovered**\
How many of those abandoned checkouts were successfully converted into purchases through your recovery emails.

**Revenue Recovered**\
The total amount of money brought back from recovered carts.

***

## **Payment Recovery**

Control how Blink automatically brings customers back.

**Abandoned cart emails**\
Turn this on to send a sequence of 3 reminder emails to customers who didn’t complete checkout.

Emails are sent automatically at:

* 1 hour after abandonment
* 24 hours after abandonment
* 72 hours after abandonment

These emails are designed to gently remind, build urgency, and bring customers back to finish their purchase.

***

## **Recovery Discount (%)**

Add an incentive to increase conversions.

By default, a discount is automatically included in the **second and third emails** to encourage customers to complete their purchase.

You can adjust the percentage to whatever fits your pricing strategy.

***

## **Cart Recovery via API**

If you are building custom checkout flows or want to manage your own marketing campaigns outside of Blink, you can fully control the cart recovery process using the Blink API.

Here is what you can do programmatically:

* **List Abandoned Carts (`GET /cart-recovery`)**: Retrieve all abandoned carts, optionally filtering by status (`open`, `recovered`, or `expired`) and `product_id`.
* **Generate Recovery Links (`GET /cart-recovery/:id/link`)**: Generate a live checkout recovery URL without triggering an email from Blink. This is perfect for custom SMS campaigns (via Twilio) or advanced email flows (via Klaviyo).
* **Trigger Native Emails (`POST /cart-recovery/trigger`)**: Manually fire Blink’s native recovery email sequence for a specific cart. The system automatically adjusts the subject line based on how many reminders have already been sent.
* **Archive Carts (`DELETE /cart-recovery/:id`)**: Programmatically dismiss or archive carts from your dashboard if you've already handled them manually.
* **Webhooks**: Sync your external CRM in real-time by listening to `abandoned_cart.created` and `abandoned_cart.recovered` events.

For full technical details, visit the [API Reference](/api-reference/introduction).


# Checkout links
Source: https://docs.blink.store/checkout-links



Create unique checkout experiences for specific use cases.

***

### **How to Create & Customize Checkout Links**

When creating a new custom checkout link, you'll see a builder divided into three main tabs: **Design**, **Behavior**, and **Integrate**. Each tab gives you powerful tools to tailor the buying experience for your customers.

Here is a breakdown of what every option does:

#### **1. The Interface Tab**

This tab controls the visual appearance of your checkout page, you can set your checkout colors and control a wide variety of options :

<Frame>
  <img alt="Clean Shot 2026 07 25 At 17 58 14" />
</Frame>

* **Colors:** Customize the color palette, primary accent colors, links, selections, theme and more.
* **Checkout Layout:** Select your preferred layout style: Classic and Overlay.<br />Overlay:
* **Product:** Select which product you'd like to create a custom checkout to.
* **Pricing box alignment:** Switch the position of the pricing details between left and right columns.
* **Disable Logo Link:** Prevents buyers from clicking on your brand logo to navigate away from the checkout page.
* **Show Title:** Displays the main product title at the top of the checkout block.
* **Show Image Carousel:** Enables a media gallery/carousel to showcase your product preview images.
* **Show Product Description**: Displays the full rich-text description beneath the media preview.
* **Truncate Description**: Adds a "Read more / Show less" toggle to keep long product descriptions concise and clean.
* **Lock Seats:** Locks the item quantity, preventing buyers from increasing or decreasing the number of licenses/units at checkout.
* **Collect Full Name:** Requires customers to enter their full name alongside their email address before completing the purchase.
* **Allow Discount Codes:** Adds a coupon field allowing customers to apply promotional codes at checkout.
* **Preview Button:** Displays a quick-preview button next to the product title.
* **Refund Policy:** Includes a direct link to your refund policy in the checkout footer.
* **Attach Bump:** Enables an optional order bump offer (add-on product) directly inside the checkout flow.

#### **2. The Behavior Tab**

This tab controls what happens behind the scenes during and after the transaction.

* **Success URL:** Enter a custom webpage URL here to automatically redirect customers after a successful purchase (e.g., a custom "Thank You" page on your website). *Pro-tip: You can include* `{CHECKOUT_ID} `*in the URL to pass the transaction ID to your page.*
* **Return URL:** Enter a URL where customers should be redirected if they click the back button or cancel the checkout process.
* **Preset Discount:** Want to send a link with a discount already applied? Enter the promo code here (e.g., `FALL20`). When customers open the link, the discount will be automatically applied to their total.
* **Lock Seats:** Turn this on to lock the quantity field. This prevents buyers from accidentally (or intentionally) changing the number of items they are purchasing.
* **Custom Metadata (JSON):** For advanced users! Add hidden data (like tracking IDs, campaign names, or affiliate tags) in JSON format. This data will be attached to the order and sent via webhooks for your internal tracking.

#### **3. The Integrate Tab**

Once your checkout is designed and configured, this is where you grab the final product.

* **Select Product:** Use the dropdown at the top of the sidebar to choose which product this link is for.
* **Direct Link:** Copy the final, unique URL. You can paste this link into your emails, social media bios, or attach it to a "Buy Now" button on your own website!


# Creating a store
Source: https://docs.blink.store/creating-a-store



Blink lets you create multiple stores under one account, so you can manage different brands or projects separately. Each store has its own setup, meaning you’ll need to add payout details and complete verification for each one individually.

When you sign up for Blink, your first store is created automatically during onboarding—so you’re ready to go right away. You can always create more stores later by simply clicking the “Add Store” button whenever you need one.

<Frame>
  <img alt="Store Blink" />
</Frame>


# Customers
Source: https://docs.blink.store/customers



Get a clear overview of your customers and subscribers all in one place. See your total customers, subscribers, and revenue at a glance, along with a detailed list showing how each person interacts with your store.

**Customer Details & Entitlements**

Clicking on any customer in your Audience list opens their **Customer Details** page. Here you can see their full order history, active subscriptions, and granted Entitlements. If you have a customer with a canceled subscription and need to manually revoke access to a specific deliverable (such as a GitHub repository), you can manage their Entitlements and click **Revoke** directly from this page.

**Export subscribers**

Download your customers and subscribers as a CSV file anytime, so you can easily import them into your email tools and stay in touch.


# Customization
Source: https://docs.blink.store/customization



Make your store truly yours.

**Theme**

Choose between light and dark mode for your storefront and checkout, and fine-tune your global colors to match your brand.

**Store logo and favicon**<br />Upload or update your store’s logo and favicon.

* Supported formats: JPEG, PNG, SVG, WebP
* Aspect ratio: 1:1 (square)
* Max file size: 1MB

**Header title & description**

Add a catchy title and a short description to tell customers what your store is all about.

**Newsletter**

Turn your newsletter on or off, and customize the title and button text to match your tone.

**Header layout**

Decide how many products you want to display per row on your storefront.

**Hover effect**

Pick how your product cards behave on hover (desktop only) to add a bit of personality to your browsing experience.


# Deleting products
Source: https://docs.blink.store/deleting-products



Once a product is published and receives at least one sale, it can’t be deleted—only archived. This ensures that customers always have access to what they’ve purchased.

Archived products are automatically moved to the Archived tab, and you can unarchive them anytime if you want to make them active again.


# Deliverables
Source: https://docs.blink.store/deliverables



Deliverables are what your customer receives after placing an order.
For maximum flexibility, you can attach any of the following deliverables to fully automate your fulfillment:

<Accordion title="Files">
  Upload files to deliver directly to your customers after purchase. Add a clear title and, if you want, a short description to give them context.
</Accordion>

<Accordion title="Button (Link)">
  Add a link that customers can access right after purchase. Perfect for Remix links, download pages, or instant redirects to your content.

  Redirect to URL<br />Send your customers to a specific URL like a remix link or any page.

  Copy to clipboard<br />Anything you paste will be copied to customer's clipboard when clicked.
</Accordion>

<Accordion title="Custom">
  Add any extra information you want customers to see in their order details after purchase. Perfect for sharing things like private notes, access instructions, or any sensitive info.
</Accordion>

<Accordion title="License Keys">
  Automatically generate and issue software license keys upon purchase. You can enforce activation limits and manage key validations programmatically via the API.
</Accordion>

<Accordion title="Discord Roles">
  Connect your Discord server and automatically assign specific roles to customers when they purchase.
</Accordion>

<Accordion title="GitHub Repos">
  Seamlessly grant customers access to private GitHub repositories. Customers will be automatically invited to the repository upon purchase and their access will be automatically revoked if their subscription ends.
</Accordion>

<Accordion title="Entitlements">
  Grant logical feature flags or abstract key-value pairs to users upon purchase, allowing you to gate access to specific features in your app.
</Accordion>

<Accordion title="Metered Credits">
  Issue metered credits (e.g. API requests, AI tokens, or hours) to customers when they purchase. You can report and consume these credits programmatically via the [Usage Records API](/api-reference/meters/list-usage-records). If you are building an AI app and want to charge overages automatically, check out the [Metered Billing for AI Apps](/metered-billing-ai) guide.
</Accordion>

<Accordion title="API Keys">
  Automatically generate and issue secure API keys for your developer-facing products.
</Accordion>

<Accordion title="Webhooks">
  Trigger a custom webhook payload to your servers whenever this product is purchased to build custom fulfillment logic.
</Accordion>


# Discounts
Source: https://docs.blink.store/discounts



Create and manage discount codes to boost conversions and reward your customers.

## Basic details

**Name**

Internal name for your discount. This helps you identify it later and will appear on the customer’s invoice.

Code

The code customers will enter at checkout. Generate a random code or add your own

**Amount**\
Choose how the discount is applied:

* **Percentage discount** — e.g. 10% off
* **Fixed amount discount** — e.g. \$20 off

**Apply to specific products**\
Choose whether the discount applies to selected products or your entire store.

* Disabled → applies to all products
* Enabled → select specific products

**Advanced limits**\
Add optional conditions to control how and when your discount works.

**Start date**\
Schedule the discount to become active at a specific time in the future.

**Expiry date**\
Set a date for the discount to automatically expire.

**Redemption limit**\
Limit how many times the discount can be used across all customers.\
(Note: this is a global limit, not per customer.)


# Email plans
Source: https://docs.blink.store/email-plans



Email Marketing usage is based on your subscriber count and monthly sending volume.

## **Starter Plan**

Perfect for sellers building their audience.

Includes:

* Up to 500 subscribers
* Up to 2,000 emails per month
* Basic email templates

## **Pro Plan**

Designed for larger audiences and higher-volume sending.

Includes:

* Higher subscriber limits
* Increased monthly email volume
* Premium email templates
* Priority email delivery

## **Scaling Your Plan**

As your audience grows, you can upgrade your plan to support more subscribers and larger sending volumes.

Pricing scales based on audience size, ensuring you only pay for what you need.

Email Marketing usage is based on your subscriber count and monthly sending volume.

## **Starter Plan**

Perfect for sellers building their audience.

Includes:

* Up to 500 subscribers
* Up to 2,000 emails per month
* Basic email templates

## **Pro Plan**

Designed for larger audiences and higher-volume sending.

Includes:

* Higher subscriber limits
* Increased monthly email volume
* Premium email templates
* Priority email delivery

## **Scaling Your Plan**

As your audience grows, you can upgrade your plan to support more subscribers and larger sending volumes.

Pricing scales based on audience size, ensuring you only pay for what you need.


# Email settings
Source: https://docs.blink.store/email-settings



The Settings page controls your sender identity and email compliance information.

These details are automatically applied to future broadcasts.

## **Sender Identity**

### **Default Sender Name**

The name recipients see as the sender.

### **Reply-To Email**

The email address that receives subscriber replies.

## **CAN-SPAM Compliance**

To comply with email marketing regulations, every campaign includes business identification information.

### **Company Name**

Your business or brand name.

### **Physical Address**

Your business mailing address.

This information is included in email footers to satisfy anti-spam requirements.

### **Permission Reminder**

A short message explaining why the recipient is receiving your emails.

**Example**

“You are receiving this email because you purchased a product or subscribed to updates from our store.”

Permission reminders help reduce spam complaints and improve deliverability.

## **Saving Changes**

After updating your settings, click **Save Settings** to apply them to future broadcasts.

## **Important Notes**

* Only subscribed users receive broadcasts.
* Unsubscribed contacts are automatically excluded.
* Test emails do not affect campaign analytics.
* Scheduled broadcasts can be edited before sending.
* Compliance information is automatically included in email footers.
* Cart recovery emails are sent automatically once configured.
* Email deliverability and tracking are managed by Blink behind the scenes.


# Fees
Source: https://docs.blink.store/fees



Get familiar with all the fees related to your sales and payouts.

## Transaction fees

Our standard processing fee is **5% + \$0.50** per sale. We utilize Stripe’s infrastructure to power our payments; our rate covers their base costs (2.9% + \$0.30) as well as the \$0.50 tax handling fee, so you don’t have to manage those separately.

## Subscription fees

We charge a 0.5% fee on each subscription in addition to the standard transaction fee. This fee is charged directly by Stripe, and Blink does not take any share of it.

Additional fees

For transactions involving non-US cards, Stripe applies a 1.5% international fee. We pass this cost through directly with zero markup. We also reserve the right to adjust for any future fee updates mandated by Stripe.

***

## Payout fees

Payouts are processed through Stripe and may include their standard fees. We don’t add any extra charges or markups, what you see is exactly what Stripe charges.

You’re also in full control of your withdrawals. Trigger payouts manually whenever it suits you.

**Stripe fees:**\
\$2/month for active payouts\
0.25% + \$0.25 per payout\
Currency conversion (cross-border): 0.25% in the EU, up to 1% elsewhere

***

## Cart recovery

Blink charges 2% per successful cart recovery

***

## Splits

A 2% platform fee is applied to each split payout to support split payment processing and infrastructure.

This fee is deducted from the recipient’s share before funds are transferred. Standard processing fees apply separately.

***

## Affiliates

A 2% platform fee is applied to each transaction to support affiliate tracking and infrastructure. This fee is deducted before affiliate commissions are calculated. Standard processing fees apply separately.

***

## Refunds and chargebacks

You have the flexibility to issue full or partial refunds to your customers. Please note that original transaction fees are not recoverable, as these are retained by the card networks and payment providers.

To proactively protect you from \$15 dispute fees, we may issue a refund within 30-60 days of a purchase if we identify a high risk of a chargeback. This is a preventative measure designed solely to save you from unnecessary penalty fees.

<Info>
  To maintain a healthy payment ecosystem, card networks enforce strict monitoring and penalties for accounts with elevated dispute rates (typically exceeding 0.7%). As your Merchant of Record, we take on the responsibility of managing this risk. We actively monitor transaction health and implement proactive measures to stay well below these industry thresholds, ensuring your store remains in good standing
</Info>

***

## Volume pricing

If you’re scaling fast or operating at high volume, [reach out](https://blink.store/contact) to our sales team to explore custom pricing tailored to your business.


# Geo Pricing
Source: https://docs.blink.store/geo-pricing



Increase global conversions by automatically adjusting pricing based on a buyer’s country and purchasing power.

Geo-Pricing detects a customer’s location and applies the appropriate discount during checkout, allowing you to offer localized pricing without creating multiple products.

**Enabling Geo-Pricing**

Navigate to **Product → Pricing → Geo-Pricing** and enable the toggle.

Once enabled, you can configure:

* Checkout banner text
* Storefront banner text
* Country-group discounts
* Country-specific overrides

**Country Groups**

Countries are organized into four pricing bundles based on purchasing power. Each bundle has a default discount percentage that you can customize.

**Country-Specific Discounts**

Need more control? Create country-specific discounts that override the default bundle discount.

For example:

* Bundle 3 discount: **30%**
* Brazil override: **40%**
* Final discount for Brazil: **40%**

**Dynamic Banner Text**

Customize the messages displayed to buyers using the following placeholders:

\*  — Displays the buyer’s country.

\*  — Displays the applied discount percentage.

<Note>
  Example storefront banner:<br />% off for customers in !
</Note>

**How Pricing Is Calculated**<br />Geo-Pricing discounts are applied to the product’s base price.

**Example:**

* Product price: **\$100**
* Country discount: **50%**
* Final price: **\$50**

Country-specific discounts always take precedence over bundle discounts.


# Getting started
Source: https://docs.blink.store/getting-started



<Frame>
  <img alt="Blink Docs Intro" />
</Frame>

## Sign up

The First step to start selling is to create an account. Head to [https://app.blink.store/](https://app.blink.store/) and sign in using Google or email to create your account and claim your store handle.

**Create your store handle**\
Your handle is your store and checkout URL, handles are unique and can be changed anytime from the setting page.

<Note>
  Changing your handle will make your previously shared links inaccessible
</Note>

Once your account is created, you'll be redirected to the your dashboard to complete your setup. Once your store is reviewed and approved, you’re all set to start selling and receiving your earnings.


# Loops Integration
Source: https://docs.blink.store/loops

Automatically sync customers and trigger email automations using our Loops integration.

Connect your Blink Store to [Loops](https://loops.so) to automatically sync your customers and trigger email sequences whenever important events happen in your store.

## Getting Started

To connect your Loops account to Blink:

1. Log in to your [Loops account](https://app.loops.so) and go to the **API** tab in your Settings.
2. Generate a new API Key and copy it.
3. In your Blink Store dashboard, navigate to **Settings** > **Integrations**.
4. Under the Loops integration, click **Connect**.
5. Paste your Loops API Key and save.

That's it! Blink will now automatically dispatch events directly to your Loops account.

***

## Supported Events

When a customer completes a purchase, Blink sends an event to Loops. If the customer does not exist in your Loops audience, they are automatically added.

Currently, Blink supports the following event:

### `Order Placed`

Triggers whenever a customer successfully places an order (both paid and free checkouts).

**Event Properties:**

* `productName`: The name of the product purchased.
* `price`: The price of the product.
* `orderId`: The unique identifier of the order.

You can use these event properties as variables inside your Loops email templates (e.g., `Thanks for buying {{productName}}!`).


# Merchant of records
Source: https://docs.blink.store/merchant-of-records



A Merchant of Record (MoR) is the official seller in a transaction. Instead of you being the legal party selling to customers, Blink steps in and takes that role on your behalf.Blink only allows adding digital products you own, adding a product that infringes copyrights may result in immediate termination of your account.\
\
**How it works?**

When someone buys your product through Blink, the purchase is technically made from us. That means we’re responsible for everything that happens during and after the transaction—from processing the payment to handling any legal or financial obligations tied to the sale.

**Blink as your Merchant of Record**

Blink operates as your Merchant of Record, so you don’t have to deal with the complicated side of selling globally. We take care of the heavy lifting while you stay focused on building and growing your product.

Here’s what Blink handles for you:

* Payments across different countries and currencies
* Tax compliance, including calculating, collecting, and remitting sales taxes
* Refunds and disputes, including chargebacks
* Ongoing transaction management and compliance

With Blink acting as your MoR, you’re free to sell worldwide without getting buried in operational or legal complexity.


# Metered Billing for AI Apps
Source: https://docs.blink.store/metered-billing-ai

An end-to-end guide on granting credits and charging overages for AI applications

Building an AI application often requires a hybrid billing model: you want to charge a flat subscription fee that includes a base allowance of AI credits, and then seamlessly charge users for any usage that exceeds that allowance.

Blink natively supports this model by combining **Subscription Products**, **Metered Credits Deliverables**, and our **Usage Records API**. This guide walks you through the entire lifecycle.

## 1. Create the Product and Configure Overage Pricing

The foundation of your billing model is the Product. Here, you define the flat subscription fee (e.g., \$20/month) and the overage rate (e.g., \$0.005 per credit).

When creating your product (via the dashboard or the API), ensure you set:

* **Pricing Model**: `subscription`
* **Subscription Interval**: `month` (or your preferred cycle)
* **Metered Pricing**: Enable metered pricing (`has_metered: true` in the API) and define your `metered_prices` tiers. This explicitly sets the overage rate that Stripe will use when the user exhausts their base allowance.

<Note>
  **Sub-cent Pricing (e.g., \$0.005 per token)**
  Because the API accepts prices in integer cents (`unit_amount`), you cannot directly specify \$0.005 (which is half a cent). Instead, you must package your credits into blocks. For example, to charge \$0.005 per credit, price it as **\$5.00 per 1,000 credits** by setting `unit_amount: 500` and configuring a `transform_quantity` block to divide usage by 1,000.
</Note>

## 2. Issue the Base Allowance (Metered Credits Deliverable)

Now that you have a subscription product that can bill for overages, you need to grant the customer their base allowance (e.g., 10,000 AI tokens) every billing cycle.

You do this by attaching a **Metered Credits Deliverable** to your Product in the dashboard:

1. Navigate to **Deliverables** in your Blink dashboard.
2. Add a new **Metered Credits** deliverable.
3. Set the grant amount (e.g., `10,000`).
4. Select whether unused credits should roll over to the next billing cycle.
5. Attach this deliverable to your Product.

When a customer subscribes, Blink automatically provisions a Meter and grants them the specified credits. This grant resets (and potentially rolls over) automatically upon every subscription renewal.

## 3. Provision Access (API Keys)

If your app requires developers or users to authenticate programmatically, you can attach an **API Keys Deliverable** to the same product.

Blink will automatically generate secure API keys for the customer. Furthermore, if you configure the deliverable to *Revoke access on subscription end*, Blink will auto-lock the API keys if the subscription is canceled or fails to renew, instantly gating access.

## 4. Report Consumption

As the customer uses your AI application, you report their consumption to Blink using the [Usage Records API](/api-reference/meters/list-usage-records).

When you `POST /v1/usage-records` with the consumed quantity:

* Blink decrements the customer's base allowance (the meter balance).
* Behind the scenes, **Blink pushes the exact consumption event to Stripe's v2 Meter Events API.**

### How Overage is Handled

You do not need to write custom logic to detect when the balance hits zero.

1. You simply report all usage unconditionally to the `POST /v1/usage-records` endpoint.
2. Blink synchronizes the usage to Stripe.
3. At the end of the billing cycle, Stripe automatically subtracts the base allowance (granted by the deliverable) from the total reported usage.
4. If the usage exceeds the allowance, Stripe automatically invoices the customer for the difference using the **Overage Pricing** you configured on the Product in Step 1.

<Note>
  Because overages are calculated by Stripe asynchronously at the end of the billing cycle, the `POST /v1/usage-records` endpoint does not synchronously return a "new balance" or "overage incurred" payload. Rely on the invoice webhooks for final billing amounts.
</Note>


# Migrate
Source: https://docs.blink.store/migrate



We've made it very simple to all your products catalogue to Blink. Simply choose a method, connect your data and you're good to go!

<Frame>
  <img alt="Clean Shot 2026 07 25 At 18 25 52" />
</Frame>

Import from:

* **Blink:** In case you have an existing Blink store and would like to migrate products to a new store, generate an API key under your Developer tab and paste it here to run the import.
* **URL:** nter any valid product URL. Blink will automatically scrape the public product details and import it into your dashboard as a draft.
* **Polar:** Enter your Polar API key to automatically import your products. [‭‬<u>Learn how to generate a Polar API key</u>](https://polar.sh/docs/api-reference/introduction)
* **Lemon Squeezy:** Enter your Lemon Squeezy API key to automatically import your products. ‭[Learn how to generate a Lemon Squeezy API key](https://docs.lemonsqueezy.com/guides/developer-guide/getting-started)
* **Gumroad:** Enter your Gumroad application API key to automatically import your products. ‬[Learn how to generate a Gumroad Access Token](https://gumroad.com/help/article/280-create-application-api)
* **Paddle:** Enter your Paddle API key to automatically import your products.[‭‬Learn how to generate a Paddle API key](https://developer.paddle.com/api-reference/about/authentication/)
* **Whop:** Enter your Whop API key to automatically import your products. [‭‬Learn how to generate a Whop API key](https://docs.whop.com/developer/api/quickstart)
* **Dodo Payments:** Enter your Dodo Payments API key to automatically import your products. [‭‬Learn how to generate a Dodo Payments API key](https://docs.dodopayments.com/developer-resources/integration-guide)<br />


# Orders
Source: https://docs.blink.store/orders



View and manage all your sales in one place. Track purchases, access customer details, issue refunds, and handle post-purchase actions — all from this screen.

## **Order Actions**

Click the menu (⋯) next to any order to access actions:

**Refund payment**\
Issue a refund for the order.\
Use this if a customer requests a refund or there’s an issue.

**Copy ID**\
Quickly copy the order ID.

**Copy receipt URL**\
Get a shareable link to the customer’s receipt.

**Generate custom invoice**\
Create a downloadable invoice for the order.

**Resend receipt email**\
Send the receipt again to the customer.

***

## **Export Orders**

Click **Export** to download your orders as a CSV file.

Useful for:

* Accounting
* Reporting
* Importing into other tools


# Overlay checkout
Source: https://docs.blink.store/overlay-checkout



A lightweight, modal-style checkout that opens on top of your website. Perfect for landing pages, portfolios, or embeds where you want users to complete a purchase without leaving the page.

***

## **How it works**

Instead of redirecting customers to a separate checkout page, the overlay opens instantly as a popup. This keeps users in context, reduces friction, and typically improves conversion.

***

## **Select Product**

Choose which product the overlay preview will display.

The preview on the right updates in real-time so you can see exactly how your checkout will look.

***

## **Integration**

Adding the overlay checkout to your site is extremely easy if you are using a site builder like Webflow, Framer, or WordPress.

For advanced programmatic integration (e.g., using React, Next.js, or dynamically generating checkouts via our API), please see the **[Embedded Checkout Integration](/api-reference/embedded-checkout)** guide in our Developer API section.

***

## **Override Theme**

Turn this on to fully customize the overlay’s appearance.

If disabled, the overlay will inherit your store’s default styles.

***

## **Theme Mode**

Choose between:

**Dark**\
Best for modern, high-contrast experiences or dark websites.

**Light**\
Better for clean, minimal, or light-themed pages.

Pick the one that matches your website for a seamless feel.

***

## **Checkout Theme Overrides**

Fine-tune the visual details of your overlay.

**Button**\
Primary call-to-action color (e.g. “Checkout”).

**Button hover**\
Button color on hover.

**Button text**\
Text color inside buttons.

**Button text hover**\
Text color on hover.

**Link**\
Color for links inside the checkout.

**Checkbox**\
Color for selection controls.

**Selection border**\
Border color for selected options.

**Selection background**\
Background color for selected states.

***

## **When to use Overlay Checkouts**

Overlay checkouts work best when:

* You’re embedding checkout on your website or a landing page
* You want a smooth, interruption-free buying flow
* You’re selling directly from your portfolio or product page
* You want faster conversions with fewer redirects

***

## **Post-Purchase Mechanics**

When a customer successfully completes a purchase via the overlay, you have **5 distinct options** for how to handle the fulfillment and UX:

1. **Default Success Message**: If no redirect is provided, the overlay simply shows a sleek "Payment Successful" screen.
2. **Built-in Deliverables**: If digital files are attached to the product, they are automatically fetched and displayed inside the overlay's success screen for instant download.
3. **Custom Redirect (`success_url`)**: If you pass a `success_url` when creating the checkout session via API, the iframe will redirect to this URL. *(Note: This navigates inside the iframe. Best for full-page hosted checkouts rather than overlays).*
4. **Frontend JS Callback (`onSuccess`)**: The most powerful option for SaaS and marketplaces. When opening the checkout via Javascript, pass an `onSuccess` callback. Blink will emit a real-time event when the payment completes, allowing you to instantly update your UI and close the modal programmatically without reloading the page.
5. **Webhooks (`order.paid`)**: A secure, server-to-server event. The only 100% reliable way to provision SaaS accounts, as it triggers even if the customer's browser closes prematurely.

***

## **Pro tip**

Match your overlay colors to your website’s branding.\
If the transition feels seamless, users are far more likely to complete the purchase.


# Payouts
Source: https://docs.blink.store/payouts



Explore how payouts work and how you’ll receive your earnings.

<Note>
  Before you can start selling and getting paid, you’ll need to complete your [setup](/setup). Once your store is reviewed and approved, you’re all set to start selling and receiving your earnings.
</Note>

## Initiating a payout

Choose how often your available balance should be transferred to your bank account.

Manual\
You must manually request a withdrawal. Funds stay in your available balance until you do.

**Weekly (Every Monday)**\
Your available balance is automatically transferred to your bank every Monday.

**Monthly (1st of the month)**\
Your available balance is automatically transferred to your bank on the 1st of every month.

<Info>
  \*\*Funds that remain inactive in your account for an extended period will be automatically transferred to your bank account.\*\*Threshold
</Info>

## Threshold

You can withdraw your earnings once your balance reaches at least 50 USD (or the equivalent in your currency).

## Payouts dashboard

**Pending**\
Your earnings are on a short 7-day hold while everything clears. This helps keep things safe and smooth for any possible refunds.

**Available**\
Earnings fully cleared and ready to withdraw.

**Total withdrawn**\
The lifetime total of all funds successfully transferred out to your Stripe account.


# Products sorting
Source: https://docs.blink.store/products-sorting



Blink lets you control how products appear in your store by setting a custom order.

## Reorder products

Go to the Products page and click the Reorder button to open the menu. From the left panel, click or add products to move them into the Featured list on the right. You can then drag and arrange them in any order you want.

<Frame>
  <img alt="Clean Shot 2026 04 24 At 09 49 57" />
</Frame>

Once set, your store will include a Featured filter showing products in your custom order.

<Note>
  You can set your store’s default sorting option from the Design tab.
</Note>


# Revenue Sharing Models
Source: https://docs.blink.store/revenue-share

A guide to Affiliates, Splits, and Payees, and when to use each for your revenue share model.

Blink provides three distinct mechanisms for revenue sharing and money movement. Because they serve different purposes, choosing the right one is critical for your application's architecture.

## 1. Affiliates (Referral Marketing)

**Best for:** Creators, influencers, and marketers who refer customers to your store.

The Affiliate system is designed for **referral links**. When a customer clicks an affiliate link (`?via=code`) and makes a purchase, Blink automatically calculates the commission and attributes the sale to the affiliate.

* **Commission:** Fixed amount or percentage per sale.
* **Payouts:** Managed centrally by the merchant via PayPal, Wise, or manual payouts (or automatically via Stripe Connect if configured).
* **Dashboard:** Affiliates get their own dashboard to generate links, view clicks, and track conversions.

**When to use it:** You want to pay people for sending traffic to your store.

## 2. Splits (Collaborator Revenue)

**Best for:** Co-creators, business partners, or joint ventures.

Splits allow you to automatically divide revenue for a specific product across multiple Blink accounts. If you co-authored an ebook with another creator, you can set a 50/50 split on that specific product.

* **Trigger:** Applies to every sale of the connected product automatically (no referral link needed).
* **Payouts:** Payouts are transferred automatically to the collaborator's Blink account balance.
* **Visibility:** Collaborators can see the sales of the split product in their own Blink dashboard.

**When to use it:** You co-created a product with a partner and want to automate the revenue split forever.

## 3. Payees (Multi-Vendor Marketplaces)

**Best for:** Headless marketplaces, platforms, and aggregators where sellers own the product.

Payees is our deepest API integration designed for **Stripe Connect** multi-vendor platforms. Instead of simply referring a sale (Affiliate) or splitting revenue (Splits), a Payee is the *actual seller of record*.

* **How it works:** When generating a checkout session via the API (`POST /v1/checkouts`), you pass a `payee_id` (the Stripe Connect account of your vendor) and an `application_fee_amount` (your platform's cut).
* **Payouts:** The money flows directly into the Payee's Stripe account at checkout, minus your application fee. You never hold the funds.
* **Headless Only:** Payees are managed entirely via the API and do not get a Blink dashboard.

**When to use it:** You are building a custom marketplace (like an AI tool directory or a course platform) where users list and sell their own products on your frontend, and you take a platform fee.


# Seat-Based Billing
Source: https://docs.blink.store/seat-based-billing

A guide on how to build team and seat-based subscriptions with Blink.

Blink provides native primitives for building team plans and seat-based B2B SaaS. This guide explains how the `seat_quantity` attribute interacts with organizations, subscriptions, and webhooks.

## The Core Concept

In a seat-based model, you charge your customer a fixed price *per seat* (e.g., \$15/seat/month). In Blink, this is handled dynamically at checkout and throughout the subscription lifecycle using the `seat_quantity` field.

### 1. Creating the Product

To support seat-based pricing, create a standard subscription product (e.g., a "Team Plan" for \$15/month). You do not need to configure anything special on the product itself; the magic happens when the checkout is generated.

### 2. Initiating Checkout

When a team owner signs up, you generate a checkout session via the API (`POST /v1/checkouts`) and explicitly pass the starting `seat_quantity`:

```json theme={null}
{
  "product_id": "prod_123",
  "customer_email": "founder@startup.com",
  "seat_quantity": 5
}
```

Blink will automatically multiply the product price by the `seat_quantity`. In this example, the customer will be billed \$75/month.

## Managing Seats (Proration)

When a customer adds or removes team members in your app, you need to sync the new seat count with their active subscription so Stripe can handle the billing and proration.

Call `PATCH /v1/subscriptions/{id}` with the new `seat_quantity`:

```json theme={null}
{
  "seat_quantity": 6,
  "action": "swap" 
}
```

**Proration:** Because `action: swap` is used, Stripe will automatically calculate the prorated amount for the new seat for the remainder of the billing cycle and invoice the customer immediately or on the next cycle, depending on your Stripe settings.

## Organizations & Fulfillment

Blink has an internal `Organizations` feature that you can use to group customers together.

While Blink handles the *billing* math (via `seat_quantity` on the subscription), your app backend is responsible for the *access control* (e.g., inviting users to the organization and enforcing the seat limit).

1. **Listen for Webhooks:** Listen for the `subscription.updated` webhook. When the `seat_quantity` changes, update the maximum allowed users for that team in your database.
2. **Add Members:** Use the `POST /v1/organizations/{id}/members` endpoint to programmatically invite users to the team.
3. **Seat Events:** If you are using Blink's built-in organization invites, Blink will fire `customer.seat_added` and `customer.seat_removed` webhooks when members accept invites or are removed. You can use these events to trigger provisioning logic in your app.


# Setup
Source: https://docs.blink.store/setup



The setup page makes lists all the required info needed to complete and submit your store for review. You can still manage those settings from various settings in the app.

<Steps>
  <Step title="Customize your store">
    Add your store logo, support email, and set your refund policy
  </Step>

  <Step title="Add your first product">
    Simple products are standalone items with no options, featuring only one price\
    (e.g., a Framer template, Icon pack, ebook)

    [More about adding products](/add-products)
  </Step>

  <Step title="Setup your payouts">
    Complete your KYC and add your bank details
  </Step>

  <Step title="Submit your store for review">
    All set? Submit your store for review. We’ll check everything to make sure it’s good to go. It takes up to 8 hours, then you’re ready to start selling.
  </Step>
</Steps>


# Sharing a product
Source: https://docs.blink.store/share-product



How to share checkout links and embed overlay checkouts to your site.

## Sharing checkout links

\
**Product**

By default, the product you clicked “Share” on will already be selected. You can easily switch and choose any other product from your list if needed.

**Checkout**

Choose whether this link uses your default store checkout or a custom one you’ve created. It’s a great way to tailor the experience to match each product.

For example, if your store runs in light mode but you’re selling a dark-mode Framer template, you can create a matching dark checkout just for that product, keeping everything consistent from start to finish.

## Sharing checkout overlay

To embed Blink checkouts on your website, simply copy the overlay code and drop it into your site, no setup headaches. You’re free to style the trigger button however you like, so it fits perfectly with your design.

**Overlay options**\
Control what shows inside the checkout:

* Show product images
* Show description
* Show discount code

**Post purchase**\
Decide what happens after the payment goes through:

* **Show deliverables**\
  Display files or access directly inside the overlay
* **Redirect to URL**\
  Send customers to any page you choose (thank you page, onboarding, download hub, etc.)


# Create a split
Source: https://docs.blink.store/splits-create-a-split



## **Split Types**

### **Percentage Split**

Share a percentage of every sale.

**Example**

Product sold for \$100

* Creator receives: \$90
* Recipient receives: \$10 (10% split)

### **Fixed Amount Split**

Share a fixed amount from every sale.

**Example**

Product sold for \$100

* Creator receives: \$95
* Recipient receives: \$5 (fixed split)

## **Platform Fee**

Blink charges a **\$2 platform fee per recipient** when a split invitation is accepted.

This fee is charged to the recipient and helps cover payout processing and split management.


# Invites
Source: https://docs.blink.store/splits-invites



The **Invites** tab acts as your inbox for pending revenue split requests.

When another seller creates a split and adds your email address or account as a recipient, the invitation appears here for review. Before any revenue can be shared, you must choose whether to accept or decline the invitation.

### **What You’ll See**

#### **Store**

The store that sent the invitation.

#### **Split Name**

The name of the revenue-sharing agreement.

#### **Your Share**

The percentage or fixed amount being offered to you.

### **Accepting an Invitation**

When you accept an invitation:

* The split becomes active.
* The partnership moves to the **Received** tab.
* Future qualifying sales begin generating earnings for you.
* Revenue is distributed automatically according to the split terms.

### **Declining an Invitation**

If you decline:

* The invitation is removed.
* No revenue-sharing relationship is created.
* You will not receive earnings from that split.


# Overview
Source: https://docs.blink.store/splits-overview



Splits let you automatically share revenue from your products with partners, affiliates, collaborators, and co-founders. Instead of manually sending payouts, Blink handles the distribution for you every time a sale is made.

You can create splits for your entire store or for specific products, invite recipients by Store ID or email, and track earnings and distributions in real time.

## **How Splits Work**

1. Create a split.
2. Choose whether the split applies to all products or selected products.
3. Add one or more recipients.
4. Define each recipient’s share.
5. Send invitations.
6. Once recipients accept, Blink automatically distributes their share from future sales.

Recipients must have a Blink account before they can receive payouts.

## **Payouts and chargebacks**

The original seller handles all refunds, disputes, and chargebacks, since they are the one processing the actual sale. If any of these occur, the split amount is automatically clawed back/deducted from the invited seller's balance.

The invited seller gets credited with the split amount on each sale, and it follows the exact same payout system/schedule as the original seller. The split revenue sits in their pending balance, clears after the standard delay (7 days), and is swept into their regular scheduled payouts.


# Received
Source: https://docs.blink.store/splits-received



The **Received** tab is your active partnership dashboard.

When you accept a revenue split invitation, it moves from **Invites** to **Received**. Every split listed here represents an active revenue-sharing agreement where another seller is automatically sharing a portion of their sales with you.

As qualifying sales occur, your share is automatically distributed according to the split terms.

### **What You’ll See**

#### **Store**

The store owner sharing revenue with you.

#### **Split Name**

The name of the revenue-sharing agreement.

#### **Your Share**

The percentage or fixed amount you receive from each qualifying sale.

#### **Status**

The current status of the partnership.

### **Active Revenue Sharing**

Once a split is active:

* Revenue is distributed automatically on qualifying sales.
* No manual payout requests are required.
* Your earnings accumulate as new sales are made.
* You can view all active revenue-sharing partnerships in one place.

### **Important Notes**

* Only accepted splits appear in this tab.
* Revenue is only earned from future qualifying sales.
* Changes made by the split owner apply to future transactions only.


# Store checkout
Source: https://docs.blink.store/store-checkout



Customize how your store checkout looks and behaves.

**How to Customize Your Store Checkout** You can easily control how your checkout pages look and behave directly from the Store Builder.

<Frame>
  <img alt="Clean Shot 2026 07 25 At 17 53 30" />
</Frame>

1. Head to your **Design** tab in the sidebar click the **Checkout** tab at the top of the left sidebar.
2. Select a specific product from the **Product** dropdown to preview how its checkout looks in real-time.
3. Use the toggle switches to customize the experience. You can choose to show or hide the image carousel, toggle the rich text description (and set it to truncate with a "Read more" button), enable discount codes, display a live preview button, and more!
4. Click **Publish** to instantly push your checkout changes live.

***


# Settings
Source: https://docs.blink.store/store-settings



This is where you control how your store looks, behaves, and connects to the outside world. From your store name to analytics and tax details — everything lives here.

***

## **Store Information**

Basic details about your store that customers will see and interact with.

**Store name**<br />Your brand name. This shows up on receipts, invoices, and checkout pages.

**Store URL**<br />Your public store link.<br />This is what customers use to access your store (e.g. `yourstore.blink.store`).

**Support email**<br />Where customers can reach you.<br />This email appears on receipts and invoices, so make sure it’s active and monitored.

**Location**<br />Your business country.<br />Used for compliance, payouts, and tax handling.

**Currency**<br />Your store’s main currency.<br />All prices and sales will be calculated in this currency.

**Supported currencies**

* USD (US Dollar)
* EUR (EURO)
* GBP (British Pound)
* CAD (Canadian Dollar)
* AUD (Australian Dollar)
* JPY (Japanese Yen)
* CHF (Swiss Franc)
* SEK (Swedish Krona)
* INR (Indian Rupee)
* BRL (Brazilian Real)

***

## **Localization**

Configure the languages used across your storefront and checkout.<br /><br />Storefront language<br />This dictates the language of the storefront UI (e.g. "Add to Cart"). Content you write (like product descriptions) will not be automatically translated.<br /><br />**Checkout Language**<br />If left on Automatic, the checkout will intelligently adapt to the buyer's browser language.

<Tip>
  You can force a checkout language by selecting one.
</Tip>

***

## **Custom Domain**

Use your own domain instead of your default [yourstore.blink.store](http://yourstore.blink.store) address. Once connected, customers visiting your Blink store will see your custom domain, and anyone visiting your Blink URL will be automatically redirected.

**Before you start**

You’ll need:

* A domain name you own (for example, `mybrand.com` or `shop.mybrand.com`)
* Access to your domain’s DNS settings through your registrar or hosting provider (such as Cloudflare, GoDaddy, Namecheap, Squarespace, etc.)

**Step 1: Add your domain**

1. Open **Store Settings → Domains**.
2. Enter your domain name.
3. Click **Add Domain**.

You can connect either:

* A root domain (`yourdomain.com`)
* A subdomain (`store.yourdomain.com`)

After adding it, Blink will generate the DNS records required to verify ownership.

**Step 2: Configure your DNS**

Blink will display the DNS records you need to add.

For each record:

* **Type** – The DNS record type (A, CNAME, TXT, etc.)
* **Name** – The hostname (often `@` for the root domain)
* **Value** – The destination provided by Blink

Add every record exactly as shown in your domain provider’s DNS settings.

**Step 3: Verify your domain**

After saving the DNS records:

1. Return to **Store Settings → Domains**.
2. Click **Verify Connection**.

DNS changes usually take a few minutes, but in some cases can take up to **48 hours** to propagate worldwide.

If verification doesn’t succeed immediately, wait a little longer and try again.

**Domain Statuses**

**Pending Verification**

Blink is waiting for your DNS records to propagate or match the required configuration.

**Verified**

Your domain is connected successfully. Customers can now access your store using your custom domain.

Blink will also automatically redirect visitors from your default `yourstore.blink.store` URL to your custom domain.

**Removing a domain**

Click **Remove** to disconnect your custom domain from Blink.

After removal:

* Your custom domain will no longer point to your Blink store.
* Customers can still access your store using your default `yourstore.blink.store` address.
* You may safely remove the Blink DNS records from your domain provider if you no longer plan to use the domain with Blink.

**Troubleshooting**

**Verification keeps failing**

* Double-check every DNS record for typos.
* Make sure all required records have been added.
* Wait for DNS propagation if the records were added recently.

**My domain still doesn’t work**

* DNS changes can take up to 48 hours, although they’re often much faster.

**Can I change my custom domain later?**

* Yes. Remove the existing domain and connect a new one at any time.

This style matches Blink’s product voice: concise, friendly, and focused on getting users from point A to point B without overwhelming them with DNS terminology.

***

## **Refund Policy**

Define how refunds work for your store and what customers should expect.

**Refund policy**<br />Choose your refund timeframe (or no refunds).

**Message**<br />This is what customers will see before purchasing.<br />Use it to clearly explain your policy and avoid confusion later.

<Tip>
  Be clear and direct. A simple, honest policy builds trust and reduces disputes.
</Tip>

***

## **Social Links**

Add links to your online presence.

You can include:

* Your website
* X (Twitter)
* Any other relevant platforms

These links will appear on your store's footer.

***

## **Search Engine Optimization (SEO)**

Control how your store appears when shared or discovered online.

**SEO Title**<br />The headline shown in search results and previews.<br />Keep it short and clear (under 60 characters).

**SEO Description**<br />A short summary of your store.<br />This appears in search engines and link previews.

**SEO Social Image**<br />The image shown when your store is shared on platforms like iMessage, Discord, or social media. Use something clean, bold, and on-brand.

***

## **Tracking & Pixels**

Track performance, conversions, and customer behavior.

**Google Analytics Measurement ID**<br />Connect your store to Google Analytics to track traffic and user activity.

**Meta Pixel ID**<br />Track conversions from Facebook and Instagram ads.

**X (Twitter) Pixel ID**<br />Measure performance from X campaigns.

**TikTok Pixel ID**<br />Track conversions and optimize TikTok ads.

**Advanced: Custom Head Scripts**<br />Add scripts that load in the `<head>` of your store.<br />Useful for analytics tools or third-party integrations.

**Advanced: Custom Body Scripts**<br />Add scripts that load before the closing `<body>` tag.<br />Typically used for tracking or chat widgets.

Only add scripts if you know what they do — incorrect scripts can break your store.

***

## **Notifications**

Manage customer and account notifications

***

## **Subscriptions**

Manage how subscriptions and billing are handled.

**Allow multiple subscriptions**<br />Customers can have multiple active subscriptions of the same product at the same time.

**Grace period for benefit revocation**<br />How long to wait before revoking benefits after a subscription fails all payment retries.

**Customer portal**<br />Control what customers can see and do in their portal.

**Allow email address changes**<br />Allow customers to change the email address associated with their account.<br /><br />**Enable subscription plan changes**<br />Allow customers to change their subscription plan from the portal.

***

## **Team Members**

Invite colleagues and assign them specific permissions to manage your store.

Blink offers granular permission control, but to make things easy, we provide several Quick Select Templates:

* **Admin:** Has full access to manage all aspects of the store (except deleting the store).
* **Financial:** Can view financial metrics, sales, and manage payouts.
* **Manager:** Can manage products, orders, marketing tools, design, and settings.
* **Support:** Can view and manage orders, handle refunds, and manage customer data.
* **Developer:** Can access developer settings (API keys, webhooks), manage test mode, design, and products.
* **Owner:** The creator of the store. Has irrevocable full access, including the ability to delete the store and manage team members.

You can also create completely custom roles by mixing and matching individual permissions.

***

## Danger Zone

This is permanent and cannot be undone.

**Delete store**<br />Deletes your store and all associated data.<br />Products, customers, sales — everything is removed.

<Note>
  S**tores can only be deleted once all final transactions have fully cleared the holding period and been transferred to your bank account.**
</Note>


# Supported countries
Source: https://docs.blink.store/supported-countries



We currently send payouts to sellers in 118 countries. Blink allows customers to purchase your products from almost anywhere in the world, with only a small number of restricted regions.

<Info>
  If your country isn’t included in our supported list, Blink isn’t available for you just yet. That said, we’re actively expanding coverage and would love to hear where you’re based as we grow.
</Info>

**Payouts available in:**

* 🇦🇱 Albania
* 🇩🇿 Algeria
* 🇦🇴 Angola
* 🇦🇬 Antigua and Barbuda
* 🇦🇷 Argentina
* 🇦🇲 Armenia
* 🇦🇺 Australia
* 🇦🇹 Austria
* 🇦🇿 Azerbaijan
* 🇧🇸 Bahamas
* 🇧🇭 Bahrain
* 🇧🇩 Bangladesh
* 🇧🇪 Belgium
* 🇧🇯 Benin
* 🇧🇹 Bhutan
* 🇧🇴 Bolivia
* 🇧🇦 Bosnia and Herzegovina
* 🇧🇼 Botswana
* 🇧🇳 Brunei
* 🇧🇬 Bulgaria
* 🇰🇭 Cambodia
* 🇨🇦 Canada
* 🇨🇱 Chile
* 🇨🇴 Colombia
* 🇨🇷 Costa Rica
* 🇭🇷 Croatia
* 🇨🇾 Cyprus
* 🇨🇿 Czech Republic
* 🇩🇰 Denmark
* 🇩🇴 Dominican Republic
* 🇪🇨 Ecuador
* 🇪🇬 Egypt
* 🇸🇻 El Salvador
* 🇪🇪 Estonia
* 🇪🇹 Ethiopia
* 🇫🇮 Finland
* 🇫🇷 France
* 🇬🇦 Gabon
* 🇬🇲 Gambia
* 🇩🇪 Germany
* 🇬🇷 Greece
* 🇬🇹 Guatemala
* 🇬🇾 Guyana
* 🇭🇰 Hong Kong
* 🇭🇺 Hungary
* 🇮🇸 Iceland
* 🇮🇳 India
* 🇮🇩 Indonesia
* 🇮🇪 Ireland
* 🇮🇱 Israel
* 🇮🇹 Italy
* 🇨🇮 Ivory Coast
* 🇯🇲 Jamaica
* 🇯🇵 Japan
* 🇯🇴 Jordan
* 🇰🇿 Kazakhstan
* 🇰🇪 Kenya
* 🇰🇼 Kuwait
* 🇱🇦 Laos
* 🇱🇻 Latvia
* 🇱🇮 Liechtenstein
* 🇱🇹 Lithuania
* 🇱🇺 Luxembourg
* 🇲🇴 Macao
* 🇲🇬 Madagascar
* 🇲🇾 Malaysia
* 🇲🇹 Malta
* 🇲🇺 Mauritius
* 🇲🇽 Mexico
* 🇲🇩 Moldova
* 🇲🇨 Monaco
* 🇲🇳 Mongolia
* 🇲🇦 Morocco
* 🇲🇿 Mozambique
* 🇳🇦 Namibia
* 🇳🇱 Netherlands
* 🇳🇿 New Zealand
* 🇳🇪 Niger
* 🇳🇬 Nigeria
* 🇲🇰 North Macedonia
* 🇳🇴 Norway
* 🇴🇲 Oman
* 🇵🇰 Pakistan
* 🇵🇦 Panama
* 🇵🇾 Paraguay
* 🇵🇪 Peru
* 🇵🇭 Philippines
* 🇵🇱 Poland
* 🇵🇹 Portugal
* 🇶🇦 Qatar
* 🇷🇴 Romania
* 🇷🇼 Rwanda
* 🇱🇨 Saint Lucia
* 🇸🇲 San Marino
* 🇸🇦 Saudi Arabia
* 🇸🇳 Senegal
* 🇷🇸 Serbia
* 🇸🇬 Singapore
* 🇸🇰 Slovakia
* 🇸🇮 Slovenia
* 🇿🇦 South Africa
* 🇰🇷 South Korea
* 🇪🇸 Spain
* 🇱🇰 Sri Lanka
* 🇸🇪 Sweden
* 🇨🇭 Switzerland
* 🇹🇼 Taiwan
* 🇹🇿 Tanzania
* 🇹🇭 Thailand
* 🇹🇹 Trinidad and Tobago
* 🇹🇳 Tunisia
* 🇹🇷 Turkey
* 🇦🇪 United Arab Emirates
* 🇬🇧 United Kingdom
* 🇺🇸 United States
* 🇺🇾 Uruguay
* 🇺🇿 Uzbekistan
* 🇻🇳 Vietnam


# Framer plugin
Source: https://docs.blink.store/untitled-page



The Blink Framer plugin seamlessly bridges your Blink store with your Framer website. It allows you to effortlessly embed products into your designs, import your entire Blink catalog into a Framer CMS collection, and start selling directly from your Framer site in seconds.

## [→ Get the Framer plugin](https://www.framer.com/community/marketplace/plugins/blink/)

<Frame>
  <img alt="Framer Plugin Image" />
</Frame>

## **Getting Started**

To use the plugin, you must first connect it to your Blink account.

1. Open your project in Framer.
2. Launch the **Blink** plugin from the Framer plugin menu.
3. Click the **Connect** button.
4. A browser window will open asking you to securely authenticate with your Blink account.
   * *Note: If a window does not open automatically, the plugin will provide a secure link for you to copy and paste into your browser.*
5. Once authorized, return to Framer. The plugin will automatically refresh and display your store's products.

***

## **Features & Workflows**

The plugin features two distinct tabs depending on how you want to build your store in Framer: **Products (Canvas Mode)** and **CMS Mode**.

### **1. Canvas Mode (Drag & Drop Buttons)**

If you are building a simple landing page or a single-product site, Canvas mode allows you to inject smart checkout buttons directly into your designs.

* Ensure you are editing a standard Framer canvas (not inside a CMS template).
* In the plugin, select the **Products** tab.
* Browse or search for the product you want to sell.
* Hover over the product and click the **(+) Insert Button** icon.
* A fully functional, customizable Blink Checkout button will instantly appear on your canvas linked to that specific product.

### **2. CMS Mode (Storefront Sync)**

If you are building a full e-commerce storefront with multiple products, the best approach is to sync your Blink catalog into a Framer Managed CMS Collection.

* Open the plugin and navigate to the **CMS** tab.
* Select the products you wish to import by clicking the checkbox on each product (or select all).
* Click **Import to CMS**.
* The plugin will automatically create a new Managed Collection called "Blink" in your Framer project.
* It will automatically generate and populate fields for the product's Name, Price, Description, Image, Preview Link, and a dynamic Checkout URL.
* You can now bind this CMS collection to your Framer components, allowing you to design dynamic storefront grids and product pages!

***

## **Important Requirements & Permissions**

To use the **CMS Sync** feature, the Blink plugin requires permission to manage your Framer CMS.

* When importing for the first time, ensure you grant the plugin the **CMS** permissions if prompted by Framer.
* If you accidentally deny these permissions, the plugin will disable the Import button and display an alert. You can fix this by managing your plugin permissions within your Framer project settings.

## **Troubleshooting**

* **Popup Blocked / Authentication Failing:** If you are using the Framer Desktop app or have strict popup blockers, the login window might not launch automatically. Simply copy the provided login link, paste it into your default browser (like Chrome or Safari), log in, and the plugin will detect the success automatically.
* **Missing Products:** Ensure your products are published and active in your Blink dashboard. The plugin will only pull active products.


# Upsells
Source: https://docs.blink.store/upsells



One-Click Upsells Increase your Average Order Value (AOV) by offering your customers additional products immediately after their initial purchase. Blink Store's One-Click Upsells are presented natively in the checkout flow, allowing customers to add an extra item to their order without having to re-enter their payment details.

How Upsells Work When a customer completes a purchase, instead of seeing the standard order confirmation page, they are immediately presented with your Upsell offer. If they click to accept, their saved payment method is instantly charged for the additional amount, and the product is seamlessly added to their existing order. If they decline, they simply proceed to their receipt.

## Creating an Upsell

To set up your first Upsell, navigate to Growth Tools > Upsells in your dashboard and click Create Upsell.

## Trigger rules

1. General Details Internal Name: A name for your upsell to identify it in your dashboard (customers won't see this). Status: Toggle the upsell active or inactive.
2. Trigger Rules Define exactly when this upsell should be shown to a buyer: <br />**Any product in store:** The upsell will be shown regardless of what the customer just bought.<br />**Specific products / variants:** The upsell will only trigger if the customer's cart contains specific products or variants you select. (You can add multiple trigger rules).

## The Offer

Select the product you want to pitch in this upsell:

**Offer Product:** Choose an existing product from your store to serve as the upsell item. <br />**Discount:** Encourage conversions by offering a special deal! You can apply a Fixed Amount or Percentage discount.<br />**Show Original Price:** Toggle this on to display a strikethrough of the original price next to the discounted price, highlighting the deal's value.

## Customization

Customize the look and feel of the upsell page to match your brand and optimize conversions:

**Title:** The main headline shown at the top (e.g., "Wait, add this to your order!").<br />**Accept/Decline Buttons:** Customize the text for both the buy button and the "No thanks" link. **Colors:** Fully customize button, and headline colors (including gradients) using the built-in color picker.

## Tracking Performance

On your Upsells dashboard, you can track the exact performance of each offer:

**Views:** How many times the upsell was shown.<br />**Claims:** How many times the upsell was purchased.<br />**Conversion Rate:** The percentage of viewers who bought the upsell.<br />**Revenue Generated:** The total additional revenue driven by the upsell.


# Zapier Integration
Source: https://docs.blink.store/zapier

Connect Blink Store with thousands of apps using our Zapier integration.

Automate your workflows by connecting Blink Store to over 5,000+ apps on Zapier. With our Zapier integration, you can automatically trigger actions in other apps whenever important events happen in your store.

## Getting Started

To start building automations with Blink Store on Zapier:

1. Click on our [Zapier Invite Link](https://zapier.com/developer/public-invite/244862/d0575209a74e0247d1a515bdc924536f/) and click **Accept Invite & Build a Zap**.
2. Log in to your Zapier account if you haven't already.
3. Once accepted, you can create a Zap and search for **Blink Store** in the trigger step (it will appear under "By Invite").
4. Select the trigger event you want to use (e.g., *Order Created*).
5. Click **Continue** and sign in to your Blink Store account when prompted. You will need to provide your **API Key** (which you can generate in your Blink Store Developer Settings).
6. Set up your action step with any other app on Zapier (like Gmail, Slack, or Google Sheets).

***

## Available Triggers

Blink Store offers a comprehensive set of triggers to help you automate every aspect of your business.

### Orders & Checkouts

* **Order Created**: Triggers when a new order is placed.
* **Order Refunded**: Triggers when an order is refunded.
* **Checkout Created**: Triggers when a checkout session is created.
* **Checkout Completed**: Triggers when a checkout is completed.
* **Checkout Expired**: Triggers when a checkout session expires.

### Customers & Subscriptions

* **Customer Created**: Triggers when a new customer is created.
* **Customer Updated**: Triggers when customer details are updated.
* **Subscriber Added**: Triggers when a new subscriber joins the audience.
* **Seat Added**: Triggers when a seat is assigned to a member.
* **Seat Removed**: Triggers when a seat is removed from a member.
* **Subscription Created**: Triggers when a subscription is created.
* **Subscription Updated**: Triggers when a subscription is updated.
* **Subscription Trial Ended**: Triggers when a subscription trial ends.
* **Subscription Canceled**: Triggers when a subscription is canceled.
* **Subscription Expired**: Triggers when a subscription expires.
* **Subscription Past Due**: Triggers when a subscription becomes past due.

### Products & Discounts

* **Product Created**: Triggers when a product is created.
* **Product Updated**: Triggers when a product is updated.
* **Product Archived**: Triggers when a product is archived.
* **Bundle Created**: Triggers when a bundle is created.
* **Bundle Updated**: Triggers when a bundle is updated.
* **Bundle Archived**: Triggers when a bundle is archived.
* **Discount Created**: Triggers when a discount is created.
* **Discount Updated**: Triggers when a discount is updated.
* **Discount Deleted**: Triggers when a discount is deleted.

### Growth Tools (Upsells & Bumps)

* **Upsell Created**: Triggers when an upsell is created.
* **Upsell Updated**: Triggers when an upsell is updated.
* **Upsell Deleted**: Triggers when an upsell is deleted.
* **Upsell Claimed**: Triggers when an upsell is claimed.
* **Bump Paid**: Triggers when a bump is purchased.
* **Abandoned Cart Created**: Triggers when a cart is abandoned.
* **Abandoned Cart Recovered**: Triggers when an abandoned cart is recovered.

### Affiliates & Splits

* **Affiliate Created**: Triggers when an affiliate application is created.
* **Affiliate Approved**: Triggers when an affiliate application is approved.
* **Affiliate Conversion**: Triggers when an affiliate records a conversion.
* **Affiliate Payout Processed**: Triggers when an affiliate payout is processed.
* **Split Created**: Triggers when a split is created.
* **Split Updated**: Triggers when a split is updated.
* **Split Deleted**: Triggers when a split is deleted.

### Financials

* **Payout Created**: Triggers when a payout is created.
* **Payout Paid**: Triggers when a payout is successfully paid.
* **Payout Failed**: Triggers when a payout fails.
* **Payout Canceled**: Triggers when a payout is canceled.

***

### Example Automations

* **Slack Notifications**: Send a message to a Slack channel every time an *Order is Created*.
* **Email Marketing**: Add a customer to a Mailchimp or ConvertKit sequence when a *Subscriber is Added*.
* **Spreadsheet Tracking**: Log all *Affiliate Conversions* into a Google Sheet for easy tracking.