> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blink.store/llms.txt
> Use this file to discover all available pages before exploring further.

# List custom checkout links

> Retrieve a paginated list of all custom checkout links for the store.

- **Request Headers:**
  - `x-store-id` (string, required): The ID of the store requesting the checkout links.

- **Query Parameters:**
  - `limit` (integer, optional): Number of items per page.
  - `page` (integer, optional): Page number to retrieve.
  - `status` (string, optional): Filter by status of checkout links.

- **Response:** A paginated list of checkout links including metadata.

Useful for managing and tracking customized checkout experiences.



## OpenAPI

````yaml /api-reference/blink-api.json get /checkout-links
openapi: 3.0.0
info:
  title: Blink API
  description: Comprehensive API documentation for Blink.
  version: 1.0.0
servers:
  - url: https://api.blink.store/v1
security:
  - storeIdHeader: []
tags:
  - name: Invoices
    description: Unified merchant of record invoices for products and subscriptions.
  - name: Geo Pricing
    description: Resolve Purchasing Power Parity (PPP) localized pricing.
paths:
  /checkout-links:
    get:
      tags:
        - Checkouts
      summary: List custom checkout links
      description: |-
        Retrieve a paginated list of all custom checkout links for the store.

        - **Request Headers:**
          - `x-store-id` (string, required): The ID of the store requesting the checkout links.

        - **Query Parameters:**
          - `limit` (integer, optional): Number of items per page.
          - `page` (integer, optional): Page number to retrieve.
          - `status` (string, optional): Filter by status of checkout links.

        - **Response:** A paginated list of checkout links including metadata.

        Useful for managing and tracking customized checkout experiences.
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
          description: Number of items per page.
        - name: page
          in: query
          schema:
            type: integer
          description: Page number to retrieve.
        - name: status
          in: query
          schema:
            type: string
          description: Filter by status of checkout links.
      responses:
        '200':
          description: Checkout links retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutLinksList'
      security:
        - storeIdHeader: []
components:
  schemas:
    CheckoutLinksList:
      type: object
      properties:
        meta:
          type: object
          properties:
            total:
              type: integer
            page:
              type: integer
            limit:
              type: integer
            has_more:
              type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutLinkDetails'
    CheckoutLinkDetails:
      type: object
      properties:
        id:
          type: string
        store_id:
          type: string
        name:
          type: string
        design:
          $ref: '#/components/schemas/CheckoutDesign'
        status:
          type: string
        views:
          type: integer
        sales:
          type: integer
        created_at:
          type: string
          format: date-time
    CheckoutDesign:
      type: object
      description: >-
        Configuration for the visual layout, display options, and colors of a
        custom checkout.
      properties:
        layout:
          type: string
          enum:
            - classic
            - overlay
            - inline
            - split
            - minimal
          description: >-
            The overall layout structure of the checkout page. `classic` is
            standard, `overlay` highlights product imagery, `inline` embeds the
            form, `split` divides into two columns, and `minimal` removes all
            distractions.
        display_options:
          type: object
          properties:
            preview_button:
              type: boolean
              description: Show a preview button next to the product title.
            discount_code:
              type: boolean
              description: Show a discount input field at checkout.
            refund_policy:
              type: boolean
              description: Display a refund policy link in the footer.
        override_theme:
          type: boolean
          description: >-
            If true, ignores the global store theme and uses the custom colors
            defined below.
        colors:
          type: object
          properties:
            button:
              type: string
              description: Primary button color.
            button_hover:
              type: string
              description: Button color when hovered.
            button_text:
              type: string
              description: Text color inside buttons.
            button_text_hover:
              type: string
              description: Text color when hovering over buttons.
            link:
              type: string
              description: Color for clickable links.
            checkbox:
              type: string
              description: Color of variants checkbox.
            selection_border:
              type: string
              description: Border color for selected variants/methods.
            selection_background:
              type: string
              description: Background color for selected states.
  securitySchemes:
    storeIdHeader:
      type: apiKey
      in: header
      name: x-store-id

````