These docs are for v1.0. Click to read the latest docs for v3.

Orders API

Get all orders data

Response Params

URL Parameters

Type

Description

id

text

Ecommerce order id

name

text

Ecommerce order name

line_items

object

Ecommerce order line item

{[
Structure of the line items remains same as the ecommerce platform, additional parameters from recurpay are shown below.
type: Order type, determines if it is one time or subscription,
plan_id: Plan id if the line item type is subscription
][ Structure of the line items remains same as the ecommerce platform, additional parameters from recurpay are shown below. type: Order type, determines if it is one time or subscription, plan_id: Plan id if the line item type is subscription ]}

customer_id

text

Ecommerce customer id

payment_order_id

text

Payment gateway order id

subscription_id

number

Recurpay subscription id

currency

enum

Order currency

subtotal_price

float

Order subtotal

total_discount

float

Total discount applied for the order

total_tax

float

Total tax paid for the order

total_shipping

float

Total shipping paid for the order

total_price

float

Order total price

status

enum

Order status

shipping_address

object

The subscription’s auto expiry count

shipping_lines

object

Shipping address of the subscription

tags

text

Cancel details of the subscription

created_at

datetime

Plan created date

updated_at

datetime

Plan recent updated date

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!