Get Order#

Returns a single Order.

Request#

HTTP Method: GET

URI Path: /v3/orders/{id}

Note

For all returned data attributes, see Order Object.

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the Order.

Examples#

http

1GET /v3/orders/d9fb4666-cf4b-4409-8144-cb7535924db8 HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]

curl

1curl -i -X GET https://api.didww.com/v3/orders/d9fb4666-cf4b-4409-8144-cb7535924db8 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5    "data": {
 6        "id": "d9fb4666-cf4b-4409-8144-cb7535924db8",
 7        "type": "orders",
 8        "attributes": {
 9            "amount": "6.0",
10            "status": "completed",
11            "created_at": "2023-10-26T11:06:28.989Z",
12            "description": "DID",
13            "reference": "EBX-118849",
14            "external_reference_id": null,
15            "items": [
16                {
17                    "type": "did_order_items",
18                    "attributes": {
19                        "qty": 1,
20                        "nrc": "0.0",
21                        "mrc": "5.0",
22                        "prorated_mrc": false,
23                        "billed_from": "2023-10-26",
24                        "billed_to": "2023-11-26",
25                        "setup_price": "0.0",
26                        "monthly_price": "5.0",
27                        "did_group_id": "2ef40a84-dfd4-45bb-8519-b4a7ebb74453"
28                    }
29                }
30            ],
31            "callback_method": null,
32            "callback_url": null
33        }
34    },
35    "meta": {
36        "api_version": "2026-11-19"
37    }
38}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.