Rate this page:

Promotions

Get promotions

GET /marketplace/catalog/partners/{partnerId}/promotions

Get a list of promotions for the specified partner. This resource requires authentication.

Request

Path parameters
partnerId Required

integer

The unique identifier for this partner

Format: int64

Example

1
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'

Responses

Content typeValue
application/json

PromotionListResponse

Create promotion

POST /marketplace/catalog/partners/{partnerId}/promotions

Create a new promotion for the specified partner. This resource requires authentication.

Request

Path parameters
partnerId Required

integer

The unique identifier for this partner

Format: int64
Body parameters
name Required

string

Name of the promotion

eligibleApps Required

Array<string>

App keys of the apps for which this promotion is applicable

startDate

string

Starting date of the promotion

Format: date
expirationDate Required

string

Expiration date of the promotion

Format: date
promotionType Required

string

Indicates whether this is a shared or single-use promotion

Valid values: SHARED_PROMOTION, SINGLE_USE_PROMOTION

discountType Required

string

Indicates whether the promotion uses flat discount or tiered discount

Valid values: FLAT_DISCOUNT

discountPercent

integer

Discount percentage if this promotion is based on a percentage discount

Format: int32
maxUses

integer

Maximum number of times this promotion can be used if it is a shared promotion

Format: int32
hostingType Required

string

Hosting environment of the apps for which this promotion is applicable.

Valid values: SERVER, DATA_CENTER, CLOUD

subscriptionType

string

Used for cloud promotions to specify type of subscription.

Valid values: MONTHLY, ANNUAL

allowedBillingCycles

integer

Number of billing cycles the promotions is valid for. Used for cloud promotions.

Format: int32
allowUnlimitedUses

boolean

True if the promotions is valid for unlimited uses.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
}'

Responses

Successfully created

Content typeValue
application/json

CreatePromotionResponse

Get promotion

GET /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}

Get a specific promotion for the specified partner. This resource requires authentication.

Request

Path parameters
partnerId Required

integer

The unique identifier for this partner

Format: int64
promotionId Required

integer

The unique identifier for this promotion

Format: int32

Example

1
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'

Responses

Content typeValue
application/json

PromotionResponse

Update promotion

PATCH /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}

Update a specific promotion for the specified partner. This resource requires authentication.

Request

Path parameters
partnerId Required

integer

The unique identifier for this partner

Format: int64
promotionId Required

integer

The unique identifier for this promotion

Format: int32
Body parameters
name

string

Name of the promotion

startDate

string

Starting date of the promotion

Format: date
expirationDate

string

Expiration date of the promotion

Format: date
discountPercent

integer

Discount percentage if this promotion is based on a percentage discount

Format: int32
maxUses

integer

Maximum number of times this promotion can be used if it is a shared promotion

Format: int32
allowedBillingCycles

integer

Number of billing cycles the promotions is valid for. Used for cloud promotions.

Format: int32

Example

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
}'

Responses

Successfully modified

A schema has not been defined for this response code.

Get promotion codes

GET /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes

Get a list of single-use codes for the specified promotion.

This resource requires authentication.

Request

Path parameters
partnerId Required

integer

The unique identifier for this partner

Format: int64
promotionId Required

integer

The unique identifier for this promotion

Format: int32

Example

1
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'

Responses

Content typeValue
application/json

PromotionCodesResponse

Create promotion code

POST /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes

Create a new single-use code for the specified promotion.

This resource requires authentication.

Request

Path parameters
partnerId Required

integer

The unique identifier for this partner

Format: int64
promotionId Required

integer

The unique identifier for this promotion

Format: int32

Example

1
2
3
curl --request POST \
  --url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes' \
  --user 'email@example.com:<api_token>'

Responses

Successfully created

A schema has not been defined for this response code.

Get promotion code

GET /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes/{promotionCode}

Get a specific single-use code for the specified promotion.

This resource requires authentication.

Request

Path parameters
partnerId Required

integer

The unique identifier for this partner

Format: int64
promotionId Required

integer

The unique identifier for this promotion

Format: int32
promotionCode Required

integer

The unique identifier for this promotion code

Format: int32

Example

1
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'

Responses

Content typeValue
application/json

PromotionCodeResponse

Delete promotion code

DELETE /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes/{promotionCode}

Delete a specific single-use code for a specific promotion associated with a specific partner.

This resource requires authentication.

Request

Path parameters
partnerId Required

integer

The unique identifier for this partner

Format: int64
promotionId Required

integer

The unique identifier for this promotion

Format: int32
promotionCode Required

integer

The unique identifier for this promotion code

Format: int32

Example

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>'

Responses

Successfully deleted

A schema has not been defined for this response code.

Get promotion status

GET /marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/status

Get a specific promotion status for the specified partner. This resource requires authentication.

Request

Path parameters
partnerId Required

integer

The unique identifier for this partner

Format: int64
promotionId Required

integer

The unique identifier for this promotion

Format: int32

Example

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'

Responses

Content typeValue
application/json

string

Rate this page: