The customer's phone number. A maximum length of 15 characters including country code. For example; +919876543210.

The customer's email address. A maximum length of 64 characters. For example; gaurav.kumar@example.com.

Possible values-0; If a customer with the same details already exist; fetches details of the existing customer.1 (default)- If a customer with the same details already exists; throws an error.

Customer's GST number; if available. For example; 29XAbbA4369J1PA.

Customer's name. Alphanumeric value with period (.); apostrophe (') and parentheses are allowed. The name must be between 3-50 characters in length. For example; Gaurav Kumar.

This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs; 256 characters (maximum) each. For example; "note_key"

The number of customer records to be retrieved from the system. The default value is 10. The maximum value is 100. This can be used for pagination in combination with skip.

count

The number of customer records that must be skipped. The default value is 0. This can be used for pagination in combination with count.

skip

The unique identifier linked to the customer.

cust_id

Customer's name. Alphanumeric; with period (.); apostrophe (') and parentheses allowed. The name must be between 3-50 characters in length. For example; Gaurav Kumar..
contact

The currency associated with the invoice. You must mandatorily pass this parameter if accepting international payments. If you have passed currency as a sub-parameter in the line_item object; you must ensure that the same currency is passed in both places. Know about the list of supported international currencies.

You can pass the customer_id in this field; if you are using theCustomers API. If not; you can pass the customer object described in the below fields.

Invoice is created in draft state when value is set to 1.

Defines who handles the email notification. Possible values-0- You send the notification to the customer.1 (default)- Razorpay sends the notification to the customer.

Timestamp; in Unix format; at which the invoice will expire.

Indicates whether the customer can make a partial payment on the invoice. Possible values- true- The customer can make partial payments.false (default)- The customer cannot make partial payments.

Defines who handles the SMS notification. Possible values- 0- You send the notification to the customer.1 (default)- Razorpay sends the notification to the customer.

Indicates the type of entity. Here; it is invoice.

The unique identifier of the invoice whose details are to be viewed.

inv_id

The unique identifier of the invoice whose details are to be updated.

Unique identifier of the invoice that you want to delete.

The unique identifier of the invoice that needs to be issued.

The unique identifier of the invoice whose link is to be sent by SMS or email.

medium

Indicates whether the notifications were sent successfully. Possible values-true- The notifications were successfully via SMS; email or both. false- The notifications were not sent.

The unique identifier of the invoice that needs to be cancelled.

The currency in which the amount should be charged. Check the list of supported currencies.

Unix timestamp; in seconds; from when the items are to be fetched.

form

Unix timestamp; in seconds; till when the items are to be fetched.

Number of items to be fetched.Default value- 10;Maximum value- 100.This can be used for pagination; in combination with the skip parameter.

Number of records to be skipped while fetching the items.

Fetches number of active or inactive items. The value is 1 for active items.The value is 0 for inactive items.

active

The unique identifier of the item whose details are to be fetched.

item_id

The unique identifer of the item whose details are to be updated.

Indicates the status of the item. Possible values- true (default)- Item is in the active state. false- Item is in the inactive state.

The price of the item in the lowest unit of currency.

The currency in which the amount should be charged. Check the list of supported currencies

The unique identifier of the item that must be deleted.

The amount for which the order was created; in currency subunits. For example; for an amount of ₹295; enter 29500. Payment can only be made for this amount against the Order.

ISO code for the currency in which you want to accept the payment. The default length is 3 characters. Refer to the list of supported currencies.

Minimum amount that must be paid by the customer as the first partial payment. For example; if an amount of ₹7000 is to be received from the customer in two installments of #1 - ₹5000; #2 - ₹2000; then you can set this value as 500000. This parameter should be passed only if partial_payment is true.

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs; 256 characters (maximum) each.

Indicates whether the customer can make a partial payment. Possible values-true The customer can make partial payments;false (default) The customer cannot make partial payments.

Receipt number that corresponds to this order; set for your internal reference. Can have a maximum length of 40 characters and has to be unique.

authorized

Retrieves the orders that contain the provided value for receipt.

receipt

Timestamp (in Unix format) from when the orders should be fetched.

Timestamp (in Unix format) up till when orders are to be fetched.

The number of orders to be fetched. The default value is 10. The maximum value is 100.This can be used for pagination; in combination with skip.

The number of orders to be skipped. The default value is 0. This can be used for pagination; in combination with count.

Used to retrieve additional information about the payment. Using this parameter will cause a sub-entity to be added to the response.

expand[]

Unique identifier of the order to be retrieved.

order_id

Unique identifier of the order in which the Notes field must be updated.

The unique identifier of the Payment Link that needs to be updated.

plink_id

Indicates whether customers can make partial payments using the Payment Link. Possible values-true- Customer can make partial payments.false (default)- Customer cannot make partial payments

Timestame; in Unix format; when the payment links should expire

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs;256 characters (maximum) each. For example; "note_key"- "Beam me up Scotty”.

Adds a unique reference number to an existing link

Unique identifier of the payment associated with the Payment Link

payment_id

The unique reference number entered by you while creating the Payment Link

reference_id

Indicates whether customers can make partial payments using the Payment Link. Possible values- true- Customer can make partial payments.false (default)- Customer cannot make partial payments.

Amount to be paid using the Payment Link. Must be in the smallest unit of the currency. For example- if you want to receive a payment of ₹300.00; you must enter the value 30000.

If callback_url parameter is passed; callback_method must be passed with the value get.

If specified; adds a redirect URL to the Payment Link. Once customers completes the payment; they are redirected to the specified URL

A three-letter ISO code for the currency in which you want to accept the payment. For example; INR.

A brief description of the Payment Link. The maximum character limit supported is 2048

Timestamp; in Unix; at which the Payment Link will expire. By default; a Payment Link will be valid for six months from the date of creation. Please note that the expire by date cannot exceed more than six months from the date of creation

Minimum amount; in currency subunits; that must be paid by the customer as the first partial payment. Default value is 100. Default currency is INR. For example- if an amount of ₹700.00 is to be received from the customer in two installments of #1 - ₹500.00; #2 - ₹200.00; then you can set this value as 500000. Must be passed along with accept_partial parameter.

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs; 256 characters (maximum) each. For example; "note_key"; "Beam me up Scotty”.

Defines who handles Payment Link notification.

Reference number tagged to a Payment Link. Must be a unique number for each Payment Link. The maximum character limit supported is 40

Used to send reminders for the Payment Link. Possible values- true- To send reminders.false- To disable reminders.

Must be set to true for creating UPI Payment Link

Unique identifier of the Payment Link that should be resent

Medium through which the Payment Link must be resent. Possible values-sms/email

Unique identifier of the order for which you want to fetch payment details.

UNIX timestamp; in seconds; from when payments are to be fetched.

UNIX timestamp in seconds till when payments are to be fetched.

Number of payments to be fetched.Default value is 10. Maximum value is 100. This can be used for pagination; in combination with the skip parameter.

Number of records to be skipped while fetching the payments.

Used to retrieve additional information about the payment; the method used to make the payment. The response will include a sub-entity if this parameter is used.
Possible values-card- Expanded card details; usable for card and EMI payments.emi- Expanded EMI plan details; usable for EMI payments.

expend[]

Unique identifier of the payment to be retrieved.

pay_id

applicable for EMI payments.offers - Expanded Offer details; applicable when an offer was applied to the payment.

Unique identifier of the payment for which the Notes field should be updated.

Unique identifier of the payment for which you want to retrieve card details.

Unique identifier of the payment to be captured.

The amount to be captured (should be equal to the authorised amount; in the smallest unit of the chosen currency).

ISO code of the currency in which the payment was made. Refer to the list of supported currencies.

Fetch Expanded Card or EMI Details for Payments

This; combined with period; defines the frequency. If the billing cycle is 2 months; the value should be 2.

Notes you can enter for the contact for future reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example; "note_key"- "Beam me up Scotty”.

This combined with interval; defines the frequency. Possible values- daily/weekly/monthly/yearly

The Unix timestamp from when plans are to be fetched.

The Unix timestamp till when plans are to be fetched.

The number of plans to be fetched. Default value is 10. Maximum value is 100. This can be used for pagination in combination with skip.

The number of plans to be skipped. Default value is 0. This can be used for pagination in combination with count.

The unique identifier of the plan. For example; plan_00000000000001.

plan_id

The unique identifier of the payment which needs to be refunded.

The amount to be refunded. Amount should be in the smallest unit of the currency in which the payment was made. Required in case of partial refund.For a partial refund

A unique identifier provided by you for your internal reference.

Here; it must be optimum. Indicates that the refund will be processed at an optimal speed based on Razorpay's internal fund transfer logic. If the refund can be processed instantly; Razorpay will do so irrespective of the payment method used to make the payment. If an instant refund is not possible; Razorpay will initiate a refund that is processed at the normal speed.

Unix timestamp at which the refunds were created.

from

Unix timestamp till which the refunds were created.

The number of refunds to fetch. You can fetch a maximum of 100 refunds.

Unique identifier of the refund which is to be retrieved.

rfnd_id

Unique identifier of the refund for which the Notes field should be updated.

Additional information to be modified or added as part of Notes field in key-pair format. Know more about notes.

Unique identifier of the payment for which the refund has been made.

Unique identifier of the refund to be retrieved.

Unique identifier of the payment for which refund has been requested

The number of refunds to fetch for the payment.

The number of refunds to be skipped for the payment.

The amount; in paise; you want settled to your account.

This is a custom note you can pass for the instant settlement for your reference. For example; Need this to make vendor payments.Maximum length- 30 characters.Allowed characters- a-z; A-Z; 0-9 and space.

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs; 256 characters (maximum) each. For example- Beam me up Scotty.

Possible value- true- Razorpay will settle the maximum amount possible. Values passed in the amount parameter are ignored.false (default value)- Razorpay will settle the amount requested in the amount parameter.

Pass this if you want to fetch payout details as part of the response.

expand[]=ondemand_payouts

Unix timestamp (in seconds) from when instant settlements are to be retrieved.

Unix timestamp (in seconds) till when instant settlements are to be retrieved.

Number of instant settlement records to be retrieved.Default value- 10.Maximum value- 100.This can be used for pagination; in combination with skip.

Number of instant settlement records to be skipped.Default value- 0 This can be used for pagination; in combination with count.

The unique identifier for the instant settlement transaction. For example; setlod_FNj7g2YS5J67Rz.

sod_id

The year the settlement was received in the YYYY format. For example; 2022.

year

The month the settlement was received in the MM format. For example; 06.'
day

month

Specifies the number of available settlements to be fetched. Maximum count can be 1000.

Specifies the number of available settlements to be skipped when fetching a count.

The unique identifier of the settlement to be retrieved.

setl_id

Unix timestamp (in seconds) till when settlements are to be fetched.

Number of settlement records to be fetched. Default value- 10 Maximum value- 100This can be used for pagination; in combination with skip.

Number of settlement records to be skipped.Default value- 0 This can be used for pagination; in combination with count.

The unique identifier linked to the Subscription. For example; sub_00000000000001

subscription_id

Indicates whether the communication to the customer would be handled by you or us. Possible values- 0- communication handled by you.1 (default)- communication handled by Razorpay.

Unix timestamp that indicates till when the customer can make the authorisation payment. For example; 1581013800. Do not pass any value if you do not want to set an expiry date.

Notes you can enter for the contact for future reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example; "note_key"

The customer's email and phone number to which notifications are to be sent. Use this array only if you have set the customer_notify parameter to 1. That i; Razorpay sends notifications to the customer.

The unique identifier of the offer that is linked to the Subscription. You can obtain this from the Dashboard. For example; offer_JHD834hjbxzhd38d.

The number of times the customer should be charged the plan amount per invoice. For example; a customer subscribes to use software. The charges are ₹100/month/license. The customer wants 5 licenses. You should pass 5 as the quantity. The customer is charged ₹500 (5 x ₹100) monthly. By default; this value is set to 1.

Unix timestamp that indicates from when the Subscription should start. If not passed

The number of billing cycles for which the customer should be charged. For example; if a customer is buying a 1-year subscription billed on a bi-monthly basis; this value should be 6.

The unique identifier of the plan for which you want to retrieve all the Subscriptions

The Unix timestamp from when Subscriptions are to be fetched.

The Unix timestamp till when Subscriptions are to be fetched.

The number of Subscriptions to be fetched. Default value is 10. Maximum value is 100. This can be used for pagination; in combination with skip.

The number of Subscriptions to be skipped. Default value is 0. This can be used for pagination; in combination with count.

The unique identifier linked to a Subscription. For example; sub_00000000000001.

sub_id

Represents who sends notifications to the customer. Possible values-1 (default)- Notifications sent by Razorpay.0- Notifications sent by you.

The unique identifier of the offer that should be linked to the Subscription. You can obtain this from the Dashboard. For example; offer_JHD834hjbxzhd38d.

The unique identifier of the new plan that should be linked to the Subscription. For example; plan_00000000000001.

The number of times the plan should be linked to the Subscription. For example; if the plan is ₹100/user/month and the customer has 5 users; you should pass 5 as the quantity to have the customer charged ₹500 (5 x ₹100) monthly. By default; this value is set to 1

This parameter is used to update the total_count for a Subscription. For example; let us consider a monthly Subscription with 12 billing cycles. The Subscription has been charged successfully 4 times and 3 more invoices have been issued; but have not been charged. The remaining count in such cases is 5. However; you can overwrite this value using this parameter

Represents when the Subscription should be updated. now (default) Updates the Subscription immediately.cycle_end- Updates the Subscription at the end of the current billing cycle.

Unix timestamp. The new start date for the Subscription.

Use this parameter to cancel a Subscription at the end of a billing cycle. Possible values-0 (default)- Cancel the subscription immediately.1- Cancel the subscription at the end of the current billing cycle.

The value should be now to pause a Subscription immediately.

The value should be now to resume a Subscription immediately.

The unique identifier of the Subscription from which you want to remove the offer. For example; sub_00000000000001.

The unique identifier of the offer you want remove from the Subscription. For example; offer_JHD834hjbxzhd38d.

Featured

Others