Skip to main content

Get checkout settings for a store (public API key only - no JWT required)

GET 
/api/v1/sdk/store/:storeId/checkout-settings

This endpoint retrieves checkout configuration settings for a store. Use this to customize your checkout UI and flow.

Authentication: Requires Public API Key (pk_*) - NO customer authentication needed. Safe for client-side use.

Response Data:

  • Available payment methods and their configuration
    • Currency and locale settings
    • Tax calculation settings and rates
    • Shipping options and rates
    • Terms and conditions URLs
    • Checkout flow preferences (guest checkout, required fields)
    • Cart expiration settings
    • Order confirmation settings

Use Cases:

  • Configuring checkout page UI
    • Displaying available payment methods
    • Calculating taxes and shipping
    • Enforcing checkout business rules
    • Customizing checkout flow based on store settings

Important Notes:

  • Settings are cached and may have a small delay for recent changes
    • This endpoint is safe to call from client-side code
    • Use retrieved settings to match store's checkout preferences

Error Scenarios:

  • 404 NOT FOUND - Store not found or inactive (Error code: STORE_NOT_FOUND)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Checkout settings retrieved successfully