Orders-orderId-quote:GET
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) m (1 revision) |
Revision as of 01:58, 17 February 2013
GET /orders/{orderId}/quote
Get quote for a given order.
Contents |
Request
GET /orders/{orderId}/quote
Request Parameters
- orderId - string
- The unique order Id. The URI of the order is returned by the POST /orders call.
URI Parameters
None.
Request Headers
- Cookie
- A cookie named OwnerId to identify the client (for most browser clients, the browser will do this automatically, depending on the browser configuration). The value of the cookie would come from the response to the create order request in the Set-Cookie response header.
Response
Status Code
- 200 OK
- The operation was successfully completed.
- 404 Not Found
- The order does not exist.
Response Body
{
"quote": {
"Hash": "42fc1e100808efc62dadf8ad027d424dff30d6f1",
"Currency": "USD",
"Products": [
{
"Services": [],
"PlanNumber": "00000139b5dd73be7f14d3f8000a88fa0fa65d70",
"Fees": [
{
"ProrationAllowed": "0",
"StartDate": "2012-09-11",
"NumCharged": "0",
"EndDate": "2012-09-11",
"Description": "Setup fee ",
"BaseAmount": "100.00",
"UnitAmount": "100.00",
"Prorated": "0",
"MonthlyCycle": "1",
"Currency": "USD",
"Amount": "100.00",
"NumCharges": "1",
"ProratedUnitAmount": "100.00",
"Type": "setup_fee",
"Quantity": "1"
},
{
"ProrationAllowed": "1",
"StartDate": "2012-09-11",
"NumCharged": "0",
"EndDate": "2012-10-10",
"Description": "Recurring fee",
"BaseAmount": "239.00",
"UnitAmount": "239.00",
"Prorated": "0",
"MonthlyCycle": "1",
"Currency": "USD",
"Amount": "239.00",
"NumCharges": "-1",
"ProratedUnitAmount": "239.00",
"Type": "recurring",
"Quantity": "1"
}
]
}
],
"Total": "339.00",
"SubTotal": "339.00",
"OneTimeFeeAmount": "100.00",
"TaxTotal": "0"
},
"links": [
{"href": "https://api.hostway.com/orders/{orderId}/quote/", "rel": "self"}
]
}
Parameters
- quote - dictionary
- Quote's ordered items info
- Hash - string
- Hash string of this particular order.
- Currency - string
- The currency for this particular order. Must be a ISO-4217 currency code. ex. USD, CAD, etc.
- Products - list
- List of plan products
- Services - list
- List of product services
- PlanNumber - string
- Plan number identifier
- Fees - list
- List of product fees
- ProrationAllowed - integer
- Number indicating whether fee proration is allowed
- StartDate - date
- Start date of the fee
- NumCharged - integer
- Number how many times this fee is charged
- EndDate - date
- End date the fee is applied
- Description - string
- Description info for this fee
- BaseAmount - decimal
- Base amount for this fee
- UnitAmount - decimal
- Unit amount for this fee
- Prorated - integer
- Integer indicating whether this fee is prorated
- MonthlyCycle - integer
- Billing cycle in months for this fee
- Currency - string
- The currency for this particular fee. Must be a ISO-4217 currency code. ex. USD, CAD, etc.
- Amount - decimal
- The actual fee amount
- NumCharges - integer
- Number of charges for this fee
- ProratedUnitAmount - decimal
- The prorated unit amount
- Type - string
- The type of this fee
- Quantity - integer
- The quantity for this fee
- Total - decimal
- Total sum for this quote
- SubTotal - decimal
- Subtotal sum for this quote
- OneTimeFeeAmount - decimal
- One time payable fee amount
- TaxTotal - decimal
- Tax total value
- links - list
- Hypermedia for this resource. Links to self.
See also
