Get a list of promotions for the specified partner in paginated way. This resource requires authentication.
integer
Requiredinteger
integer
any
boolean
any
string
boolean
string
string
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/paged' \
--user 'email@example.com:<api_token>' \
--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
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"promotions": [
{
"_links": {
"self": {
"href": "<string>"
},
"edit": {
"href": "<string>"
},
"status": {
"href": "<string>"
},
"codes": {
"href": "<string>"
},
"usage": {
"href": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"eligibleApps": [
{
"key": "<string>",
"name": "<string>"
}
],
"startDate": "<string>",
"expirationDate": "<string>",
"endImmediatelyDate": "<string>",
"creationDate": "<string>",
"status": "ACTIVE",
"promotionType": "SHARED_PROMOTION",
"discountType": "FLAT_DISCOUNT",
"discount": [
{
"pricingItemId": "<string>",
"discountAmount": 43
}
],
"discountPercent": 71,
"appliesToAllLicenseTypes": true,
"maxUses": 78,
"used": 44,
"hostingType": "SERVER",
"subscriptionType": "MONTHLY",
"allowedBillingCycles": 80,
"allowUnlimitedUses": true,
"promotionCode": "<string>"
}
],
"offset": 42,
"limit": 48,
"totalItems": 46,
"orderBy": "START_DATE",
"nextId": "<string>",
"prevId": "<string>"
}
Get a list of promotions for the specified partner.
This resource requires authentication.
It is strongly recommended to use paginated API. Refer Get promotions paged
integer
Required1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions' \
--user 'email@example.com:<api_token>' \
--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
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"promotions": [
{
"_links": {
"self": {
"href": "<string>"
},
"edit": {
"href": "<string>"
},
"status": {
"href": "<string>"
},
"codes": {
"href": "<string>"
},
"usage": {
"href": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"eligibleApps": [
{
"key": "<string>",
"name": "<string>"
}
],
"startDate": "<string>",
"expirationDate": "<string>",
"endImmediatelyDate": "<string>",
"creationDate": "<string>",
"status": "ACTIVE",
"promotionType": "SHARED_PROMOTION",
"discountType": "FLAT_DISCOUNT",
"discount": [
{
"pricingItemId": "<string>",
"discountAmount": 43
}
],
"discountPercent": 71,
"appliesToAllLicenseTypes": true,
"maxUses": 78,
"used": 44,
"hostingType": "SERVER",
"subscriptionType": "MONTHLY",
"allowedBillingCycles": 80,
"allowUnlimitedUses": true,
"promotionCode": "<string>"
}
]
}
Create a new promotion for the specified partner. This resource requires authentication.
integer
Requiredstring
Requiredarray<string>
Requiredstring
string
Requiredstring
Requiredstring
Requiredinteger
integer
string
Requiredstring
Successfully created
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl --request POST \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"eligibleApps": [
"<string>"
],
"startDate": "<string>",
"expirationDate": "<string>",
"promotionType": "SHARED_PROMOTION",
"discountType": "FLAT_DISCOUNT",
"discountPercent": 71,
"maxUses": 78,
"hostingType": "SERVER",
"subscriptionType": "MONTHLY",
"allowedBillingCycles": 80,
"allowUnlimitedUses": true,
"customPromoCode": "<string>"
}'
1
2
3
{
"id": "<string>"
}
Get a specific promotion for the specified partner. This resource requires authentication.
integer
Requiredstring
Required1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}' \
--user 'email@example.com:<api_token>' \
--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
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"edit": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"status": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"codes": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"usage": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"eligibleApps": [
{
"key": "<string>",
"name": "<string>"
}
],
"startDate": "<string>",
"expirationDate": "<string>",
"endImmediatelyDate": "<string>",
"creationDate": "<string>",
"status": "ACTIVE",
"promotionType": "SHARED_PROMOTION",
"discountType": "FLAT_DISCOUNT",
"discount": [
{
"pricingItemId": "<string>",
"discountAmount": 43
}
],
"discountPercent": 71,
"appliesToAllLicenseTypes": true,
"maxUses": 78,
"used": 44,
"hostingType": "SERVER",
"subscriptionType": "MONTHLY",
"allowedBillingCycles": 80,
"allowUnlimitedUses": true,
"promotionCode": "<string>"
}
Update a specific promotion for the specified partner. This resource requires authentication.
integer
Requiredstring
Requiredstring
string
string
integer
integer
integer
Successfully modified
1
2
3
4
5
6
7
8
9
10
11
12
curl --request PATCH \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"startDate": "<string>",
"expirationDate": "<string>",
"discountPercent": 71,
"maxUses": 78,
"allowedBillingCycles": 80
}'
Get a list of single-use codes for the specified promotion.
This resource requires authentication.
integer
Requiredstring
Required1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes' \
--user 'email@example.com:<api_token>' \
--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
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"codes": [
{
"_links": {
"self": {
"href": "<string>"
},
"usage": {
"href": "<string>"
}
},
"code": "<string>",
"created": "<string>",
"usage": {
"date": "<string>",
"orderId": 94,
"name": "<string>",
"email": "<string>",
"apps": [
{}
],
"siteUrl": "<string>",
"appEntitlementId": "<string>",
"appEntitlementNumber": "<string>"
}
}
]
}
Create a new single-use code for the specified promotion.
This resource requires authentication.
integer
Requiredstring
RequiredSuccessfully created
1
2
3
curl --request POST \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes' \
--user 'email@example.com:<api_token>'
Get a specific single-use code for the specified promotion.
This resource requires authentication.
integer
Requiredstring
Requiredinteger
Required1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes/{promotionCode}' \
--user 'email@example.com:<api_token>' \
--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
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"usage": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"code": "<string>",
"created": "<string>",
"usage": {
"date": "<string>",
"orderId": 94,
"name": "<string>",
"email": "<string>",
"apps": [
{
"key": "<string>",
"edition": "<string>",
"sen": "<string>",
"userTier": 76,
"entitlementId": "<string>",
"entitlementNumber": "<string>"
}
],
"siteUrl": "<string>",
"appEntitlementId": "<string>",
"appEntitlementNumber": "<string>"
}
}
Delete a specific single-use code for a specific promotion associated with a specific partner.
This resource requires authentication.
integer
Requiredstring
Requiredinteger
RequiredSuccessfully deleted
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes/{promotionCode}' \
--user 'email@example.com:<api_token>'
Get a specific promotion status for the specified partner. This resource requires authentication.
integer
Requiredstring
Requiredstring
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/status' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
1
"ACTIVE"
Rate this page: