API
Order Order contains all the data for an order.
id
int32
Id is the unique identifier of the order.
createDate
(read only)
string
CreateDate is the date the order was placed.
registrar
string
Registrar is registrar with which order is placed.
status
(read only)
string
Status indicates the state of the order ('success', 'failed').
currency
(read only)
string
Currency indicates currency of the order ('USD', 'CNY').
orderItems
[]*OrderItem
OrderItems is the collection of 1 or more items in the order.
authAmount
(read only)
float32
AuthAmount is the amount authorized to complete the order purchase.
totalCapture
(read only)
float32
TotalCapture is the amount captured.
totalRefund
(read only)
float32
TotalRefund is the amount, if any, refunded. Default is 0.00. If 0.00, this field is not included in response.
finalAmount
(read only)
string
FinalAmount is the final amount of the order, after discounts and refunds.
currencyRate
float32
CurrencyRate is the conversion rate from USD to order's currency. This field is only populated if order's currency is non-USD.
OrderItem OrderItem contains all the order item data.
id
int32
Id is the unique identifier of the order item.
status
string
Status indicates state of the order ('success', 'failed', 'refunded').
name
string
Name is name of the item ('example.ninja').
tld
string
Tld is (optional) tld of domain name, if applicable ('ninja').
type
string
Type is type of the item ('registration', 'whois_privacy').
price
(read only)
float32
Price is the final price of the item.
priceNonUsd
float32
PriceNonUsd is the price of the item if order has non-usd currency.
originalPrice
(read only)
float32
OriginalPrice is the original price of the item before discounts.
taxAmount
(read only)
float32
TaxAmount is the tax charged for this item, if applicable.
quantity
(read only)
int32
Quantity is the number of items.
duration
(read only)
int32
Duration is the number of intervals.
interval
(read only)
string
Interval is the unit of time ("year", "month").