An entitlement is an instantiated offering from the product catalog.
Rate limit: 3000 requests per minute.
string
RequiredFetching Entitlement Details with Limited Fields
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v2/entitlements/{entitlementId}/details' \
--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
{
"entitlementId": "<string>",
"invoiceGroupId": "<string>",
"version": 2154,
"status": "ACTIVE",
"slug": "<string>",
"offeringKey": "<string>",
"optedQuantities": [
{
"chargeElement": "<string>",
"quantity": 2154,
"source": "USER_OPTED"
}
],
"entitlementTemplate": {
"key": "<string>",
"version": 2154,
"data": {}
},
"featureOverrides": {},
"featureVariables": {},
"transactionAccountId": "<string>",
"order": {
"id": "<string>",
"itemId": "<string>"
},
"relatesToEntitlements": [
{
"entitlementId": "<string>",
"relationshipType": "<string>",
"relationshipId": "<string>"
}
],
"relatesFromEntitlements": [
{
"entitlementId": "<string>",
"relationshipType": "<string>",
"relationshipId": "<string>"
}
],
"createdAt": 2154,
"updatedAt": 2154,
"subscriptionv2": {
"id": "<string>",
"orderItemId": "<string>",
"entitlementId": "<string>",
"startTimestamp": 2154,
"endTimestamp": 2154,
"accountDetails": {
"invoiceGroupId": "<string>",
"transactionAccountId": "<string>"
},
"chargeDetails": {
"offeringId": "<string>",
"pricingPlanId": "<string>",
"chargeQuantities": [
{
"chargeElement": "<string>",
"quantity": 2154
}
],
"promotionInstances": [
{}
]
},
"trial": {
"startTimestamp": 2154,
"endTimestamp": 2154,
"pricingPlanId": "<string>",
"offeringId": "<string>",
"endBehaviour": "TRIAL_PLAN"
},
"billingPeriodDetails": {
"billingAnchorTimestamp": 2154,
"nextBillingTimestamp": 2154
},
"scheduledChanges": {
"nextCycleChange": [
{}
]
},
"status": "PROCESSING",
"pauseBilling": {
"startTimestamp": 28,
"endTimestamp": 26
},
"testFeatures": {
"billingClockId": "<string>"
}
}
}Rate limit: 600 requests per minute.
string
Requiredstring
OK
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v1/entitlements/{entitlementId}/display-info' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"entitlementId": "<string>",
"provisionedResource": {
"ari": "<string>",
"name": "<string>"
}
}Rate limit: 600 requests per minute.
integer
string
string
string
string
RequiredOK
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v1/entitlements' \
--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
{
"data": [
{
"entitlementId": "<string>",
"invoiceGroupId": "<string>",
"version": 2154,
"status": "ACTIVE",
"slug": "<string>",
"offeringKey": "<string>",
"optedQuantities": [
{
"chargeElement": "<string>",
"quantity": 2154,
"source": "USER_OPTED"
}
],
"entitlementTemplate": {
"key": "<string>",
"version": 2154,
"data": {}
},
"featureOverrides": {},
"featureVariables": {},
"transactionAccountId": "<string>",
"order": {
"id": "<string>",
"itemId": "<string>"
},
"relatesToEntitlements": [
{
"relationshipType": "<string>",
"entitlementId": "<string>",
"relationshipId": "<string>"
}
],
"relatesFromEntitlements": [
{
"relationshipType": "<string>",
"entitlementId": "<string>",
"relationshipId": "<string>"
}
],
"createdAt": 2154,
"updatedAt": 2154
}
],
"nextId": "<string>"
}Rate limit: 600 requests per minute.
string
RequiredFetching Entitlement Summary
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v1/entitlements/{entitlementId}/partner-acquisition-info' \
--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
{
"entitlementId": "<string>",
"version": 2154,
"status": "ACTIVE",
"slug": "<string>",
"createdAt": 2154,
"updatedAt": 2154,
"offeringKey": "<string>",
"transactionAccountId": "<string>",
"relatesToEntitlements": [
{
"entitlementId": "<string>",
"relationshipType": "<string>",
"relationshipId": "<string>"
}
],
"relatesFromEntitlements": [
{
"entitlementId": "<string>",
"relationshipType": "<string>",
"relationshipId": "<string>"
}
],
"subscription": {
"id": "<string>",
"status": "PROCESSING",
"nextBillingTimestamp": 2154,
"nextBillingAnchorTimestamp": 2154,
"trial": {
"startTimestamp": 2154,
"endTimestamp": 2154,
"pricingPlanId": "<string>",
"offeringId": "<string>",
"endBehaviour": "TRIAL_PLAN"
},
"accountDetails": {
"invoiceGroupId": "<string>",
"transactionAccountId": "<string>"
},
"chargeDetails": {
"offeringId": "<string>",
"pricingPlanId": "<string>",
"chargeQuantities": [
{
"chargeElement": "<string>",
"quantity": 2154
}
]
},
"pauseBilling": {
"startTimestamp": 28,
"endTimestamp": 26
},
"startTimestamp": 2154,
"endTimestamp": 2154
},
"provisionedResource": {
"ari": "<string>",
"name": "<string>"
}
}Rate this page: