An order is an entity representing a user's intent to create, amend, or delete a contract to provide the enumerated service from a billing perspective.
Rate limit: 600 requests per minute.
string
Requiredstring
RequiredOK
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v2/orders/{id}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
"orderId": "<string>",
"slug": "<string>",
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"items": [
{
"offeringId": "<string>",
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"orderItemId": "<string>",
"optedUsageOptions": {
"chargingDetails": {},
"trial": {},
"billingBehaviour": {
"type": "PAUSE_BILLING"
},
"effectiveTime": {
"endsAt": {
"type": "TIMESTAMP"
}
}
},
"type": "CREATION_ORDER",
"processingInfo": {
"status": "PROCESSING",
"entitlement": {
"id": "<string>",
"version": "<string>"
},
"transitionTimestamp": 2154,
"transitionTime": "IMMEDIATE",
"saleTransitionDetails": {},
"saleTransitionType": "NEW",
"computedDetails": {},
"accountModification": {},
"additionalTriggeredOrderItems": [
{}
],
"prorationBehaviour": "NONE",
"impactedEntitlements": [
{}
]
},
"billingOptions": {
"preBill": {
"billUntil": {
"type": "TIMESTAMP_REFERENCE"
}
}
},
"resetOptions": {
"resetType": "HARD_RESET",
"backdateTimestamp": 2154,
"resetGLPOrderItemId": "<string>",
"invoiceRequestId": "<string>"
},
"reasonCode": "<string>",
"metadata": {},
"triggeredByOrderItem": {
"orderId": "<string>",
"orderItemId": "<string>"
},
"promotions": [
{
"promotionInstanceId": "<string>",
"promotionDefinition": {}
}
],
"isImmediate": true,
"originalOrderItemId": "<string>",
"quoteLineItemDetailsReference": {
"quoteId": "<string>",
"version": 2154,
"quoteLineItemId": "<string>"
},
"subscriptionStartTime": 2154,
"transition": {
"offering": {},
"pricingPlan": {},
"applyAfterTimestamp": 2154
},
"rewindToOrderItemId": "<string>",
"billingAnchorTime": 2154,
"nextBillingAnchorTimestamp": 2154,
"backdateTimestamp": 2154,
"rebillOptions": {
"billFromTimestamp": 2154
},
"prorationBehaviour": "NONE",
"relatesFromEntitlements": [
{}
]
}
],
"additionalTriggeredOrders": [],
"createdDate": 2154
}Rate limit: 600 requests per minute.
string
Requiredstring
Requiredstring
RequiredOK
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v2/orders/{orderId}/orderItem/{orderItemId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
"orderId": "<string>",
"slug": "<string>",
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"items": [
{
"offeringId": "<string>",
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"orderItemId": "<string>",
"optedUsageOptions": {
"chargingDetails": {},
"trial": {},
"billingBehaviour": {
"type": "PAUSE_BILLING"
},
"effectiveTime": {
"endsAt": {
"type": "TIMESTAMP"
}
}
},
"type": "CREATION_ORDER",
"processingInfo": {
"status": "PROCESSING",
"entitlement": {
"id": "<string>",
"version": "<string>"
},
"transitionTimestamp": 2154,
"transitionTime": "IMMEDIATE",
"saleTransitionDetails": {},
"saleTransitionType": "NEW",
"computedDetails": {},
"accountModification": {},
"additionalTriggeredOrderItems": [
{}
],
"prorationBehaviour": "NONE",
"impactedEntitlements": [
{}
]
},
"billingOptions": {
"preBill": {
"billUntil": {
"type": "TIMESTAMP_REFERENCE"
}
}
},
"resetOptions": {
"resetType": "HARD_RESET",
"backdateTimestamp": 2154,
"resetGLPOrderItemId": "<string>",
"invoiceRequestId": "<string>"
},
"reasonCode": "<string>",
"metadata": {},
"triggeredByOrderItem": {
"orderId": "<string>",
"orderItemId": "<string>"
},
"promotions": [
{
"promotionInstanceId": "<string>",
"promotionDefinition": {}
}
],
"isImmediate": true,
"originalOrderItemId": "<string>",
"quoteLineItemDetailsReference": {
"quoteId": "<string>",
"version": 2154,
"quoteLineItemId": "<string>"
},
"subscriptionStartTime": 2154,
"transition": {
"offering": {},
"pricingPlan": {},
"applyAfterTimestamp": 2154
},
"rewindToOrderItemId": "<string>",
"billingAnchorTime": 2154,
"nextBillingAnchorTimestamp": 2154,
"backdateTimestamp": 2154,
"rebillOptions": {
"billFromTimestamp": 2154
},
"prorationBehaviour": "NONE",
"relatesFromEntitlements": [
{}
]
}
],
"additionalTriggeredOrders": [],
"createdDate": 2154
}Rate limit: 600 requests per minute.
integer
string
string
string
RequiredOK
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v2/orders' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
"data": [
{
"orderId": "<string>",
"slug": "<string>",
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"items": [
{
"offeringId": "<string>",
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"orderItemId": "<string>",
"optedUsageOptions": {},
"type": "CREATION_ORDER",
"processingInfo": {},
"billingOptions": {},
"resetOptions": {
"resetType": "HARD_RESET",
"resetGLPOrderItemId": "<string>"
},
"reasonCode": "<string>",
"metadata": {},
"triggeredByOrderItem": {},
"promotions": [
{}
],
"isImmediate": true,
"originalOrderItemId": "<string>",
"quoteLineItemDetailsReference": {},
"subscriptionStartTime": 2154,
"transition": {
"offering": {},
"applyAfterTimestamp": 2154
},
"rewindToOrderItemId": "<string>",
"billingAnchorTime": 2154,
"nextBillingAnchorTimestamp": 2154,
"backdateTimestamp": 2154,
"rebillOptions": {},
"prorationBehaviour": "NONE",
"relatesFromEntitlements": [
{}
]
}
],
"additionalTriggeredOrders": [],
"createdDate": 2154
}
],
"nextId": "<string>"
}Rate limit: 600 requests per minute.
string
string
oneOf [allOf [OrderWebRequestDtoV2, object], allOf [OrderWebRequestDtoV2, object]]
Created
1
2
3
4
5
curl --request POST \
--url 'https://api.atlassian.com/commerce/api/v2/orders' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
"orderId": "<string>",
"slug": "<string>",
"items": [
{
"itemId": "<string>",
"orderItemId": "<string>",
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"triggeredByOrderItem": {
"orderId": "<string>",
"orderItemId": "<string>"
},
"processingInfo": {
"additionalTriggeredOrderItems": [
{}
],
"computedDetails": {},
"saleTransitionDetails": {}
},
"metadata": {}
}
],
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"additionalTriggeredOrders": [],
"metadata": {}
}Rate limit: 100 requests per minute.
string
RequiredallOf [OrderIntentWebRequestDtoV2, object]
OK
1
2
3
4
5
curl --request POST \
--url 'https://api.atlassian.com/commerce/api/v2/order-intent/preview' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
"orderId": "<string>",
"slug": "<string>",
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"items": [
{
"offeringId": "<string>",
"transactionAccountId": "<string>",
"invoiceGroupId": "<string>",
"orderItemId": "<string>",
"optedUsageOptions": {
"chargingDetails": {},
"trial": {},
"billingBehaviour": {
"type": "PAUSE_BILLING"
},
"effectiveTime": {
"endsAt": {
"type": "TIMESTAMP"
}
}
},
"type": "CREATION_ORDER",
"processingInfo": {
"status": "PROCESSING",
"entitlement": {
"id": "<string>",
"version": "<string>"
},
"transitionTimestamp": 2154,
"transitionTime": "IMMEDIATE",
"saleTransitionDetails": {},
"saleTransitionType": "NEW",
"computedDetails": {},
"accountModification": {},
"additionalTriggeredOrderItems": [
{}
],
"prorationBehaviour": "NONE",
"impactedEntitlements": [
{}
]
},
"billingOptions": {
"preBill": {
"billUntil": {
"type": "TIMESTAMP_REFERENCE"
}
}
},
"resetOptions": {
"resetType": "HARD_RESET",
"backdateTimestamp": 2154,
"resetGLPOrderItemId": "<string>",
"invoiceRequestId": "<string>"
},
"reasonCode": "<string>",
"metadata": {},
"triggeredByOrderItem": {
"orderId": "<string>",
"orderItemId": "<string>"
},
"promotions": [
{
"promotionInstanceId": "<string>",
"promotionDefinition": {}
}
],
"isImmediate": true,
"originalOrderItemId": "<string>",
"quoteLineItemDetailsReference": {
"quoteId": "<string>",
"version": 2154,
"quoteLineItemId": "<string>"
},
"subscriptionStartTime": 2154,
"transition": {
"offering": {},
"pricingPlan": {},
"applyAfterTimestamp": 2154
},
"rewindToOrderItemId": "<string>",
"billingAnchorTime": 2154,
"nextBillingAnchorTimestamp": 2154,
"backdateTimestamp": 2154,
"rebillOptions": {
"billFromTimestamp": 2154
},
"prorationBehaviour": "NONE",
"relatesFromEntitlements": [
{}
]
}
],
"additionalTriggeredOrders": [],
"createdDate": 2154
}Rate this page: