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
  1. Checkout Session
  • 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
        POST
      • Retrieve Checkout Session
        GET
    • 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
  1. Checkout Session

Retrieve Checkout Session

Testing
Useepay API V2.0 Sandbox Environment
https://openapi1.uat.useepay.com
Useepay API V2.0 Sandbox Environment
https://openapi1.uat.useepay.com
GET
/v1/checkout/sessions/{session_id}
Retrieve a Checkout Session by its ID to check the current status, payment status, and other details

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path Params

Responses

🟢200
application/json
Successfully retrieved
Body

🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://openapi1.uat.useepay.com/v1/checkout/sessions/' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Checkout Session in open status (awaiting payment)
{
    "id": "cs_1A2B3C4D5E6F7G8H",
    "object": "checkout.session",
    "mode": "subscription",
    "ui_mode": "custom",
    "status": "open",
    "payment_status": "unpaid",
    "amount": 99.99,
    "currency": "USD",
    "merchant_order_id": "sub_order_jkl345mno678",
    "customer_id": "cus_9Z8Y7X6W5V4U3T",
    "customer": {
        "id": "cus_9Z8Y7X6W5V4U3T",
        "email": "trial@example.com",
        "name": "Trial User",
        "phone": "+1234567890",
        "merchant_customer_id": "cust_trial_merchant_345678"
    },
    "line_items": [
        {
            "quantity": 1,
            "price_data": {
                "product_data": {
                    "name": "Premium Monthly Plan",
                    "desc": "Unlimited access with first month discount"
                },
                "unit_amount": 99.99,
                "currency": "USD",
                "recurring": {
                    "interval": "month",
                    "interval_count": 1,
                    "total_billing_cycles": 12
                }
            }
        }
    ],
    "subscription_data": {
        "discount_period_config": {
            "discount_period_count": 1,
            "discount_period_amount": 0.01
        }
    },
    "collection_method": "auto_charge",
    "payment_method_types": [
        "card",
        "apple_pay",
        "google_pay"
    ],
    "payment_intent_id": null,
    "subscription": null,
    "invoice_id": null,
    "metadata": {
        "subscription_type": "premium",
        "billing_cycle": "monthly",
        "trial_offer": "first_month_99_percent_off"
    },
    "client_secret": "cs_1A2B3C4D5E6F7G8H_secret_abc123",
    "created": 1705228800,
    "expires_at": "2026-01-15T15:30:00Z"
}
Modified at 2026-01-15 07:30:38
Previous
Create Checkout Session
Next
upload trackers
Built with