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

# Create a product

> Creates a new product. Products represent the goods or services you sell.



## OpenAPI

````yaml /openapi.yaml post /v1/products
openapi: 3.1.0
info:
  title: Kyren Pay API
  description: >
    The Kyren Pay API enables merchants to accept payments from customers
    worldwide.

    Integrate checkout sessions, manage products, track orders, and handle
    webhooks.


    **Data types**: The API uses the following types for request/response data:

    - **string**: For text, identifiers, and **all amount/price fields** (e.g.
    `price`, `amount`, `platformFee`, `available`)
      to avoid floating-point precision issues. Use decimal format like `"9.99"`.
    - **integer**: For counts, pagination, and timestamps

    - **timestamp**: Unix timestamp in milliseconds (integer) for all time
    fields (e.g. `createdAt`, `paidAt`, `expiresAt`).
      Time parameters (e.g. `startDate`, `endDate`) also use Unix milliseconds.
  version: 1.0.0
  contact:
    name: Kyren Pay Support
    email: support@kyren.top
    url: https://kyren.top
servers:
  - url: https://api.kyren.top
    description: Production
  - url: https://staging-api.kyren.top
    description: Staging, available only with credentials issued by Kyren
security:
  - ApiKeyAuth: []
tags:
  - name: Config
    description: Retrieve platform configuration such as supported currencies.
  - name: Products
    description: Create and manage products that represent the goods or services you sell.
  - name: Checkouts
    description: Create checkout sessions to collect payments from your customers.
  - name: Orders
    description: View and manage orders created from completed checkout sessions.
  - name: Balance
    description: View your account balance and transaction history.
  - name: Epay Compatibility
    description: >
      Compatibility endpoints for existing integrations built on 易支付 API
      conventions.

      These endpoints use form/query parameters with `pid + sign` verification
      (MD5), not `x-api-key` header auth.
paths:
  /v1/products:
    post:
      tags:
        - Products
      summary: Create a product
      description: >-
        Creates a new product. Products represent the goods or services you
        sell.
      operationId: createProduct
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProductRequest'
            example:
              name: 1000 AI Credits
              description: Top up 1000 credits for AI API usage
              price: '9.99'
              currency: USD
              metadata:
                credits: '1000'
      responses:
        '200':
          description: Product created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductResponseWrapper'
              example:
                code: 0
                message: success
                data:
                  id: prod_abc123
                  name: 1000 AI Credits
                  description: Top up 1000 credits for AI API usage
                  image: null
                  price: '9.99'
                  currency: USD
                  status: ACTIVE
                  metadata:
                    credits: '1000'
                  createdAt: 1736932200000
                  updatedAt: 1736932200000
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    CreateProductRequest:
      type: object
      required:
        - name
        - price
      properties:
        name:
          type: string
          maxLength: 200
          description: The name of the product
        description:
          type: string
          maxLength: 1000
          description: A description of the product
        image:
          type: string
          description: URL of the product image
        price:
          type: string
          pattern: ^\d+(\.\d{1,2})?$
          description: The price of the product (e.g. "9.99"), must be at least 0.01
        currency:
          type: string
          default: USD
          description: Three-letter ISO currency code (e.g. USD, CNY, HKD)
        metadata:
          type: object
          additionalProperties:
            type: string
          description: Arbitrary key-value pairs for your own use
    ProductResponseWrapper:
      type: object
      properties:
        code:
          type: integer
          example: 0
        message:
          type: string
          example: success
        data:
          $ref: '#/components/schemas/Product'
    Product:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier
        name:
          type: string
        description:
          type: string
        image:
          type: string
        price:
          type: string
        currency:
          type: string
        status:
          $ref: '#/components/schemas/ProductStatus'
        metadata:
          type: object
          additionalProperties:
            type: string
        createdAt:
          type: integer
          format: int64
          description: Unix timestamp in milliseconds
        updatedAt:
          type: integer
          format: int64
          description: Unix timestamp in milliseconds
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        error:
          type: object
          properties:
            field:
              type: string
            reason:
              type: string
    ProductStatus:
      type: string
      enum:
        - ACTIVE
        - ARCHIVED
      description: |
        - `ACTIVE` — Product is available for checkout
        - `ARCHIVED` — Product is archived and cannot be used
  responses:
    BadRequest:
      description: Bad request — invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 400
            message: Bad Request
            error:
              field: productId
              reason: Product ID is required
    Unauthorized:
      description: Unauthorized — missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 401
            message: Unauthorized
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >
        Your API key. Public production API-key endpoints accept `kyren_live_*`
        keys. Staging credentials are environment-specific and must be used only
        with the staging environment for which Kyren issued them.

````