An offering represents a packaging of a product that'll result in an entitlement.
Returns the full details of an offering.
In some scenarios, this API returns a 401 (Unauthorized) for a particular offering — for example, an Atlassian-managed or internal offering. In these cases, use the Offering Summary API to retrieve the listing details for that offering.
Rate limit: 900 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredOK
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v3/offerings/{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
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ari": "<string>",
"updatedAt": 2154,
"hostingType": "CLOUD",
"level": 131,
"productId": "<string>",
"slugs": [
"<string>"
],
"pricingType": "EXTERNAL",
"status": "DRAFT",
"supportedBillingSystems": [
"HAMS"
],
"version": 2154,
"chargeElements": {},
"expiryDate": 2154,
"releaseTimestamp": 2154,
"trial": {
"lengthDays": 2154,
"allowFullTrialWithPauseBilling": true
},
"offeringGroup": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"level": 74,
"productId": "<string>"
},
"relationshipRequirements": [
{
"type": "APP_DEPENDENCE",
"side": "FROM",
"level": "ALLOWED"
}
],
"derivedOfferings": [
{
"templateId": "<string>",
"templateVersion": 2154,
"generatedOfferingId": "<string>"
}
],
"derivedFromOffering": {
"templateId": "<string>",
"templateVersion": 2154,
"originalOfferingId": "<string>"
},
"catalogAccountId": "<string>"
}Returns lightweight summaries for a batch of offerings in a single call (name, description, pricing type, product, and offering group) instead of fetching full offering details per offering. A maximum of 10 offering IDs can be requested at a time.
In some scenarios, the Offering details API returns a 401 (Unauthorized) for a particular offering — for example, an Atlassian-managed or internal offering. In these cases, use this API to retrieve the listing details for that offering.
Rate limit: 900 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
A list of offering IDs to fetch summaries for. Provide between 1 and 10 unique IDs per request.
array<string>
1Max items: 10Unique items: trueOK
array<Offerings_PublicOfferingSummaryResponse>
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/commerce/api/v3/offerings/summary' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"ari:cloud:commerce::offering/2a3b4c5d-1111-2222-3333-444455556666",
"ari:cloud:commerce::offering/7f8e9d0c-aaaa-bbbb-cccc-ddddeeeeffff"
]'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[
{
"id": "ari:cloud:commerce::offering/2a3b4c5d-1111-2222-3333-444455556666",
"name": "Jira Standard",
"description": "Jira Standard",
"pricingType": "PAID",
"product": {
"id": "ari:cloud:commerce::product/jira-software",
"name": "Jira"
},
"offeringGroup": {
"id": "ari:cloud:commerce::offering-group/jira-software",
"slug": "jira-software"
}
}
]Rate limit: 600 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredinteger
string
OK
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v1/offerings/{id}/related/{type}' \
--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
{
"values": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ari": "<string>",
"updatedAt": 2154,
"hostingType": "CLOUD",
"level": 131,
"productId": "<string>",
"slugs": [
"<string>"
],
"pricingType": "EXTERNAL",
"status": "DRAFT",
"supportedBillingSystems": [
"HAMS"
],
"version": 2154,
"chargeElements": {},
"expiryDate": 2154,
"releaseTimestamp": 2154,
"trial": {
"lengthDays": 2154,
"allowFullTrialWithPauseBilling": true
},
"offeringGroup": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"level": 74,
"productId": "<string>"
},
"relationshipRequirements": [
{
"type": "APP_DEPENDENCE",
"side": "FROM",
"level": "ALLOWED"
}
],
"derivedOfferings": [
{
"templateId": "<string>",
"templateVersion": 2154,
"generatedOfferingId": "<string>"
}
],
"derivedFromOffering": {
"templateId": "<string>",
"templateVersion": 2154,
"originalOfferingId": "<string>"
},
"catalogAccountId": "<string>"
}
],
"nextId": "<string>"
}List all offerings under the provided product key
Rate limit: 600 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
integer
string
string
OK
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v2/products/{productId}/offerings' \
--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
{
"values": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ari": "<string>",
"updatedAt": 2154,
"hostingType": "CLOUD",
"level": 131,
"productId": "<string>",
"slugs": [
"<string>"
],
"pricingType": "EXTERNAL",
"status": "DRAFT",
"supportedBillingSystems": [
"HAMS"
],
"version": 2154,
"chargeElements": {},
"expiryDate": 2154,
"releaseTimestamp": 2154,
"trial": {
"lengthDays": 2154,
"allowFullTrialWithPauseBilling": true
},
"offeringGroup": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"level": 74,
"productId": "<string>"
},
"relationshipRequirements": [
{
"type": "APP_DEPENDENCE",
"side": "FROM",
"level": "ALLOWED"
}
],
"derivedOfferings": [
{
"templateId": "<string>",
"templateVersion": 2154,
"generatedOfferingId": "<string>"
}
],
"derivedFromOffering": {
"templateId": "<string>",
"templateVersion": 2154,
"originalOfferingId": "<string>"
},
"catalogAccountId": "<string>"
}
],
"nextId": "<string>"
}Rate this page: