Standard parameters
- action = get_price
- object = domain
Attributes
Parameters within the attributes associative array are described below.
domain
Required
The domain to be queried.
period
Optional
The desired registration period. The default is 1.
reg_type
Optional
The type of registration.
Allowed values are new, renewal, and trade. The default is new.
Standard parameters
- action = reply
- object = domain
- is_success = a Boolean is returned, indicating success or failure of the
request - response_code = response code indicating outcome of the request
- response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
price
Returned if is_success =
true
The price of the queried domain. This value includes
the OpenSRS price and the ICANN fee.
Note:
A value for is_registry_premium will only be returned if:
- The domain is registry premium
- The registry premium tier into which the domain falls is enabled in the reseller's account
The accurate price for the domain will always be returned, regardless of whether or not the premium tier into which the domain falls is enabled.
is_registry_premium
Returned if is_success =
true
Indicates whether the domain is a registry premium.
Possible value is:
1 = yes
price
Returned if in the request, the value for period = 1.
The price of the queried domain for a 1-year registration period. This value includes
the OpenSRS price and the ICANN fee.
prices
Returned if, in the request, the value for period = >1.
The price of the queried domain for the registration period indicated in the request. This value includes
the OpenSRS price and the ICANN fee.
Request
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">GET_PRICE</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="period">1</item>
<item key="reg_type">new</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>Response
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="price">20.2</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="action">GET_PRICE</item>
<item key="attributes">
<dt_assoc>
<item key="domain">restful.blue</item>
<item key="period">1</item>
<item key="reg_type">new</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>Response
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command Successful</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
<item key="registry_premium_group">2</item>
<item key="price">83.99</item>
<item key="is_registry_premium">1</item>
</dt_assoc>
</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="action">GET_PRICE</item>
<item key="attributes">
<dt_assoc>
<item key="domain">restful.blue</item>
<item key="period">1</item>
<item key="reg_type">new</item>
<item key="all_periods">1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>Response
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command Successful</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
<item key="registry_premium_group">2</item>
<item key="price">83.99</item>
<item key="is_registry_premium">1</item>
<item key="prices">
<dt_assoc>
<item key="6">503.93</item>
<item key="3">251.96</item>
<item key="7">587.92</item>
<item key="9">755.89</item>
<item key="2">167.98</item>
<item key="8">671.90</item>
<item key="1">83.99</item>
<item key="4">335.95</item>
<item key="10">839.88</item>
<item key="5">419.94</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>