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

# Create Checkout

> Create a hosted checkout session idempotently.



## OpenAPI

````yaml /openapi.json post /v1/orgs/{orgId}/projects/{projectId}/payments/checkouts
openapi: 3.1.0
info:
  title: Korve API
  version: 0.1.0
  description: >-
    Typed control plane for deploying applications and explicitly provisioning
    their managed infrastructure.
servers:
  - url: https://api.korve.dev
security: []
paths:
  /v1/orgs/{orgId}/projects/{projectId}/payments/checkouts:
    post:
      tags:
        - customerPayments
      summary: Create Checkout
      description: Create a hosted checkout session idempotently.
      operationId: customerPayments.createCheckout
      parameters:
        - name: orgId
          in: path
          required: true
          schema:
            type: string
          description: The organization's id (UUID) or slug — either form is accepted.
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: The project's id (UUID) or slug — either form is accepted.
        - name: environment
          in: query
          required: false
          schema:
            type: string
            pattern: ^[a-z][a-z0-9-]{0,38}$
          description: >-
            Environment slug. Defaults to "production"; unknown environment
            slugs return 404.
      requestBody:
        required: true
        x-korve-max-bytes: 1048576
        content:
          application/json:
            schema:
              type: object
              properties:
                priceId:
                  type: string
                  format: uuid
                quantity:
                  type: integer
                  minimum: 1
                  maximum: 999
                successUrl:
                  type: string
                  format: uri
                  maxLength: 2048
                cancelUrl:
                  type: string
                  format: uri
                  maxLength: 2048
                customerId:
                  type: string
                  format: uuid
                customerEmail:
                  type: string
                  format: email
                  maxLength: 320
                clientReferenceId:
                  type: string
                  maxLength: 255
                metadata:
                  type: object
                  description: At most 20 application-defined string entries.
                  additionalProperties:
                    type: string
                    maxLength: 500
              required:
                - priceId
                - successUrl
                - cancelUrl
              additionalProperties: false
      responses:
        '201':
          description: Created checkout.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  priceId:
                    type: string
                    format: uuid
                  customerId:
                    type:
                      - string
                      - 'null'
                    format: uuid
                  mode:
                    type: string
                    enum:
                      - one_time
                      - subscription
                  quantity:
                    type: integer
                    minimum: 1
                    maximum: 999
                  status:
                    type: string
                    enum:
                      - open
                      - complete
                      - expired
                  paymentStatus:
                    type: string
                    enum:
                      - unpaid
                      - paid
                      - no_payment_required
                      - refunded
                      - partially_refunded
                  settlementStatus:
                    type: string
                    enum:
                      - pending
                      - available
                      - paid
                      - failed
                      - not_applicable
                  url:
                    type:
                      - string
                      - 'null'
                    format: uri
                    description: Hosted checkout URL. Present only on the create response.
                  clientReferenceId:
                    type:
                      - string
                      - 'null'
                  expiresAt:
                    type: string
                    format: date-time
                  createdAt:
                    type: string
                    format: date-time
                required:
                  - id
                  - priceId
                  - customerId
                  - mode
                  - quantity
                  - status
                  - paymentStatus
                  - settlementStatus
                  - url
                  - clientReferenceId
                  - expiresAt
                  - createdAt
        '402':
          description: Organization billing is not active.
        '404':
          description: Project or payment resource not found.
        '409':
          description: Duplicate idempotency key or conflicting resource state.
        '422':
          description: Invalid payment request.
        '502':
          description: The payment processor rejected the request.
        '503':
          description: The payment processor is temporarily unavailable.
      security:
        - apiKey: []
        - session: []
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: korve_api_key
    session:
      type: apiKey
      in: cookie
      name: korve.session_token

````