Checkout Settings

Configure checkout behavior, custom fields, and recurring purchase policies to customize the customer checkout experience.

Key Benefits

Custom Data Collection - Capture additional customer information through configurable checkout fields

Recurring Purchase Control - Set policies for subscription renewal options and recurring payments

Flexible Validation - Configure field requirements, lengths, and validation rules

Checkout Configuration

Custom Fields

Configure additional fields to collect customer information during checkout.

Field Properties:

Field Type - Text, number, select, checkbox options

Validation Rules - Required status, minimum/maximum lengths

Multilingual Labels - English and Arabic field labels and placeholders

Customer Profile - Option to save field data to customer profiles

Recurring Purchase Policy

Control how customers can set up recurring purchases and subscriptions.

Policy Options:

Disabled - No recurring purchase options available

Optional - Customers can choose to enable recurring purchases

Mandatory - All purchases must be set up as recurring

Field Configuration Options

Field Settings:

Field name and labels (English/Arabic)

Field type (text, select, checkbox)

Required/optional status

Placeholder and help text

Character length limits

Display ordering

Customer Usage

Common Use Cases: Retrieve checkout configuration to build custom checkout forms, validate field requirements, display proper field labels and validation rules.

Step 1. Get Checkout Configuration

Retrieve complete checkout settings including custom fields and recurring purchase policies using Checkout Config Details.

Step 2. Build Custom Cehckout Forms

Use checkout configuration to dynamically build checkout forms with proper validation and multilingual support.

Step 3. Send Customer Input as Custom Fields

After building the form, user inputs are passed in Checkout custom_fields. (e.g.)

{
  "source": "api",
  "action": "hard",
  "is_redeeming": false,
  "vouchers": [],
  "cart_id": 100,
  "custom_fields": { # Form values should be passed here
      "required_field_1": "example_value"
  }
}

CheckoutConfig

Key Benefits#

Checkout Configuration#

Custom Fields#

Recurring Purchase Policy#

Field Configuration Options#

Customer Usage#

Step 1. Get Checkout Configuration#

Step 2. Build Custom Cehckout Forms#

Step 3. Send Customer Input as Custom Fields#