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

# POST /checkout

> Create a checkout session for an order



## OpenAPI

````yaml /api/openapi/checkout-api.json post /checkout
openapi: 3.1.0
info:
  description: Checkout API for Fanfare
  title: Fanfare Checkout API
  version: 1.0.0
servers:
  - description: Production
    url: https://checkout.fanfare.io/api
  - description: Local development
    url: http://localhost:4805
security:
  - CheckoutSecretKeyAuth: []
paths:
  /checkout:
    post:
      tags:
        - Checkout
      description: Create a checkout session for an order
      operationId: postCheckout
      requestBody:
        content:
          application/json:
            schema:
              properties:
                cancelUrl:
                  type: string
                checkoutClaim:
                  type: string
                idempotencyKey:
                  type: string
                mode:
                  enum:
                    - hosted
                    - embedded
                  type: string
                successUrl:
                  type: string
              required:
                - checkoutClaim
                - mode
                - successUrl
                - cancelUrl
                - idempotencyKey
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  checkoutUrl:
                    type: string
                  expiresAt:
                    type: string
                  orderId:
                    type: string
                  paymentId:
                    type: string
                required:
                  - orderId
                  - paymentId
                  - checkoutUrl
                  - expiresAt
                type: object
          description: Checkout session created
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    const: validation_error
                  issues:
                    items:
                      properties:
                        expected:
                          type: string
                        kind:
                          type: string
                        message:
                          type: string
                        path:
                          items:
                            properties:
                              input: {}
                              key:
                                type: string
                              origin:
                                type: string
                              type:
                                type: string
                            required:
                              - type
                              - origin
                              - input
                              - key
                            type: object
                          type: array
                        received:
                          type: string
                        type:
                          type: string
                      required:
                        - kind
                        - type
                        - expected
                        - received
                        - message
                        - path
                      type: object
                    type: array
                required:
                  - error
                  - issues
                type: object
          description: Bad Request - Invalid input schema
        '401':
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: string
                required:
                  - error
                type: object
          description: Unauthorized - Authentication required
        '403':
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: string
                required:
                  - error
                type: object
          description: Forbidden - User must be authenticated
        '500':
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: string
                required:
                  - error
                type: object
          description: Internal server error
components:
  securitySchemes:
    CheckoutSecretKeyAuth:
      description: Fanfare secret key. Keep secret credentials on your server.
      scheme: bearer
      type: http

````