UseePay Open API
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
    • Integration
      • Welcome to the UseePay Demo Page
      • About Payment Methods
        • Card
        • Apple Pay Web Integration (API Integration)
        • Apple Pay(Hosted Checkout)
        • Google Pay
        • Klarna
        • Naver pay
        • Kakao Pay
        • Toss Pay
        • Payco
        • Affirm
        • Blik
        • trustly
        • Cashapp
      • subscription
        • Get started with Subscription
      • online payment
        • Get started with online payments
      • Payment Capabilities
        • Adaptive Price
        • Supported Payment Methods for Checkout
      • checkout session
        • Checkout Session Guide
    • developer
      • Introduction
      • Authentication
      • Errors
      • error code
        • last_payment_error documentation
      • Best Integration
        • Quickly create a paymentIntent for a subscription
        • Auto-Charge Subscription Guide
      • Payment Intents
        • Payment Intent Overview
        • Quickly create a paymentIntent
        • Create a PaymentIntent
        • Retrieve a PaymentIntent
        • Update a PaymentIntent
        • Confirm a PaymentIntent
        • Cancel a PaymentIntent
        • Capture a PaymentIntent
        • List all payment intents
      • Customers
        • Create a customer
        • Retrieves a customer
        • Update a customer
        • List all customers
      • Subscriptions
        • Create a subscription
        • Retrieves a subscription
        • Update a subscription
        • List all subscriptions
        • Cancel a subscription
      • Invoices
        • Create a invoice
        • Retrieves a invoice
        • List all invoices
        • Pay a invoice
      • Payment Methods
        • Create a payment method
        • Retieve Payment Method Session
        • Retrieves a payment method
        • Update a payment method
        • List all payment methods
      • Mandates
        • Create a mandate
        • Retrieves a mandate
        • List all mandates
      • Refunds
        • Create a refund
        • Retrieves a refund
        • List all refunds
      • Webhooks
        • Webhook events
        • Webhook Activation/Signature Verification Steps
        • Webhook Events Documentation (testing)
        • Create a webhook
        • Retrieves a webhook
        • Update a webhook
        • List all webhooks
      • Embedded Checkout
        • Payment Elements
        • Express Checkout Elements
        • Checkout Session Element
      • case
      • objects
      • About Testing
        • Test Cards
        • ApplePay&GooglePay
      • Payment Method Configuration
        • Retieve Payment Method Configuration
      • Checkout Session
        • Create Checkout Session
        • Retrieve Checkout Session
      • Trackers
        • upload trackers
        • Retrieve a tracker
      • Schemas
        • CheckoutSessionCreateRequest
        • LineItem
        • Customer
        • Address
        • ProductData
        • Shipping
        • SubscriptionData
        • Error
        • DiscountPeriodConfig
        • DeviceData
        • CheckoutSessionResponse
        • ErrorResponse
        • Order
        • Product
        • PaymentMethodOptions
        • RiskControlOptions
        • Mandate
        • PaymentIntent
        • PaymentMethod
        • Billing
        • Card
        • AliPay
        • Wallet
        • Klarna
        • WechatPay
        • Refund
        • Subscription
        • Recurring
        • PriceData
        • SubscriptionItem
        • Invoice
        • NextAction
        • Webhook
        • CollectableOptions
        • PaymentLink
        • last_payment_error
        • discount_period_config
        • CreatePaymentIntentRequest
    • message
      • Messaging Element
    • FAQ
      • Unable to receive Webhook notifications
    UseePay PortalMechant Dashboard
    Product Docs
    Product Docs
    • V2.0
    • V1.0
    UseePay PortalMechant Dashboard
    Product Docs
    Product Docs
    • V2.0
    • V1.0

    CheckoutSessionCreateRequest

    {
        "mode": "payment",
        "ui_mode": "custom",
        "amount": 99.99,
        "currency": "USD",
        "merchant_order_id": "order_abc123xyz456",
        "customer_id": "string",
        "customer": {
            "id": "cus_9Z8Y7X6W5V4U3T",
            "email": "customer@example.com",
            "phone": "+1234567890",
            "name": "John Doe",
            "merchant_customer_id": "cust_merchant_123456"
        },
        "line_items": [
            {
                "quantity": 1,
                "price_data": {
                    "product_data": {
                        "name": "Premium Monthly Plan",
                        "desc": "Unlimited access to all premium features"
                    },
                    "unit_amount": 99.99,
                    "recurring": {
                        "interval": "day",
                        "unit_amount": "string",
                        "interval_count": 1,
                        "total_billing_cycles": 12
                    }
                }
            }
        ],
        "payment_method_types": [
            "card",
            "apple_pay",
            "google_pay"
        ],
        "subscription_data": {
            "discount_period_config": {
                "discount_period_count": 1,
                "discount_period_amount": 0.01
            }
        },
        "collection_method": "auto_charge",
        "metadata": {
            "order_type": "online",
            "source": "web",
            "campaign": "summer_sale"
        },
        "shipping": {
            "name": "John Doe",
            "phone": "+1234567890",
            "address": {
                "line1": "123 Main Street",
                "line2": "Apartment 4B",
                "city": "New York",
                "state": "NY",
                "postcode": "10001",
                "country": "US"
            }
        },
        "billing": {
            "address": {
                "line1": "123 Main Street",
                "line2": "Apartment 4B",
                "city": "New York",
                "state": "NY",
                "postcode": "10001",
                "country": "US"
            },
            "date_of_birth": "string",
            "first_name": "string",
            "last_name": "string",
            "email": "string",
            "phone": "string"
        }
    }
    Built with