Set Checkout Fields as Read-Only

You can set Checkout fields such as contact and email as read-only. This prevents the customers from editing their contact numbers and email addresses on Checkout.

Original vs Customized Checkout Section🔗

Given below is a comparison of the Checkout section before and after the fields are set as read-only.

Original Checkout Fields	Customized Read-only Checkout Fields

Sample Code🔗

Here is a sample request and response using these parameters.

 Request Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/invoices/ \
-H 'Content-type: application/json' \
-d '{
  "amount": 680000,
  "currency": "INR",
  "description": "Cloud Computing Course Fees",
  "type": "link",
  "partial_payment": 1,
  "receipt": "991",
  "expire_by": 1679244401,
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "9999999998",
    "email": "gaurav.kumar@example.com"
  },
  #customization parameters start below#
  "options": {
    "checkout": {
      "readonly": {
        "email": 1,
        "contact": 1
      }
    }
  }
}'
Copy{
  "id": "inv_E748qFqqhMFrJh",
  "entity": "invoice",
  "receipt": "991",
  "invoice_number": "991",
  "customer_id": "cust_E745VxdPgwHRAA",
  "customer_details": {
    "id": "cust_E745VxdPgwHRAA",
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "9900990099",
    "gstin": null,
    "billing_address": null,
    "shipping_address": null,
    "customer_name": "Gaurav Kumar",
    "customer_email": "gaurav.kumar@example.com",
    "customer_contact": "9900990099"
  },
  "order_id": "order_E748qIDP3BigdQ",
  "line_items": [],
  "payment_id": null,
  "status": "issued",
  "expire_by": 1679244401,
  "issued_at": 1579596581,
  "paid_at": null,
  "cancelled_at": null,
  "expired_at": null,
  "sms_status": "pending",
  "email_status": "pending",
  "date": 1579596581,
  "terms": null,
  "partial_payment": false,
  "gross_amount": 680000,
  "tax_amount": 0,
  "taxable_amount": 0,
  "amount": 680000,
  "amount_paid": 0,
  "amount_due": 680000,
  "currency": "INR",
  "description": "Cloud Computing Course Fees",
  "notes": [],
  "comment": null,
  "short_url": "https://rzp.io/i/XqpROeU",
  "view_less": true,
  "billing_start": null,
  "billing_end": null,
  "type": "link",
  "group_taxes_discounts": false,
  "user": null,
  "created_at": 1579596581
}

Request Parameters🔗

List of request parameters to be used with the Create Payment Link API to make contact and email fields non-editable.

options mandatory

array Options to set contact and email as read-only fields on Checkout. Parent parameter under which the checkout and readonly child parameters must be passed.

checkout mandatory

array The parameter for the Checkout section. readonly is its child parameter.

readonly.contact optional: boolean Used to set the contact field as readonly. When set to 1, customer will not be able to edit this field. When set to 0, the customer will be able to enter phone number. By default, this is set to 0.
readonly.email optional: boolean Used to set the email field as readonly. When set to 1, customer will not be able to edit this field. When set to 0, the customer will be able to enter email address. By default, this is set to 0.