DEdealhub
Order

Get an order by its identifier

get/rh/orders/{orderIdentifier}

Request

  • Base URL
    https://api.app.subskribe.com
  • URL
    https://api.app.subskribe.com/rh/orders/{orderIdentifier}
  • Auth
    API key in header X-API-Key

Path parameters

orderIdentifierstring required

The order identifier

Response

successful operation

entityIdstring
namestring
orderIdentifierstring required
buyerAccountIdstring required
shippingContactIdstring required
billingContactIdstring required
currencystring required
paymentTermstring required
startDateinteger required
endDateinteger required
billingAnchorDateinteger
billingTerm'UP_FRONT' | 'IN_ARREARS' required
listAmountnumber required
totalAmountnumber required
submittedBystring
purchaseOrderRequiredForInvoicingboolean
purchaseOrderNumberstring
orderType'NEW' | 'AMENDMENT' | 'CANCEL' | 'RENEWAL' | 'RESTRUCTURE' required
orderStatus'DRAFT' | 'SUBMITTED' | 'APPROVED' | 'EXECUTED' | 'EXPIRED' required
subscriptionIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.