Pricing plans define how paid offerings are priced and charged for, and result in subscriptions.
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/v2/pricing-plans/{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
{
"id": "<string>",
"updatedAt": 2154,
"description": "<string>",
"offeringId": "<string>",
"productId": "<string>",
"offeringName": "<string>",
"ari": "<string>",
"primaryCycle": {
"name": "<string>",
"interval": "DAY",
"count": 2154
},
"status": "DRAFT",
"currency": "USD",
"type": "<string>",
"maxNewQuoteDate": 2154,
"activatedWithReason": "DEFAULT_PRICING",
"items": [
{
"cycle": {
"name": "<string>",
"interval": "DAY",
"count": 2154
},
"chargeType": "METERED",
"chargeElement": "<string>",
"tiersMode": "GRADUATED",
"chargeElementAggregationType": "LATEST",
"transformQuantity": {
"divideBy": 28,
"round": "UP"
},
"tiers": [
{
"floor": 2154,
"ceiling": 2154,
"unitAmount": 92,
"unitAmountDecimal": "<string>",
"flatAmount": 97
}
],
"prorateOnUsageChange": "CREATE_PRORATIONS",
"prorationBehaviour": {
"onExceeding": "CREATE_PRORATIONS",
"hasRemediationPeriod": true
}
}
],
"version": 2154,
"relationships": [
{
"fromPricingPlanKey": "<string>",
"toPricingPlanKey": "<string>",
"fromPricingPlanId": "<string>",
"toPricingPlanId": "<string>",
"type": "ADVANTAGE_PRICING",
"metadata": {}
}
],
"supportedBillingSystems": [
"HAMS"
],
"activationDate": 2154,
"createdBy": "<string>",
"managedBy": "<string>",
"catalogAccountId": "<string>"
}Updates the pricing plan which are in draft state
Rate limit: 100 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredarray<PublicPricingPlanItemInput>
integer
OK
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
curl --request PUT \
--url 'https://api.atlassian.com/commerce/api/v2/pricing-plans/{id}' \
--header 'Accept: application/json' \
--header 'X-Catalog-Account: <X-Catalog-Account>' \
--header 'Content-Type: application/json' \
--data '{
"primaryCycleId": "<string>",
"items": [
{
"cycleId": "<string>",
"starter": true,
"chargeType": "<string>",
"chargeElement": "<string>",
"tiersMode": "<string>",
"prorateOnUsageChange": "<string>",
"prorationBehaviour": {
"onExceeding": "<string>",
"hasRemediationPeriod": true
},
"chargeElementAggregationType": "<string>",
"transformQuantity": {
"divideBy": 28,
"round": "<string>"
},
"tiers": [
{
"floor": 40,
"ceiling": 40,
"unitAmount": 31,
"unitAmountDecimal": "<string>",
"flatAmount": 31
}
]
}
],
"version": 40
}'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
{
"id": "<string>",
"updatedAt": 2154,
"description": "<string>",
"offeringId": "<string>",
"productId": "<string>",
"offeringName": "<string>",
"ari": "<string>",
"primaryCycle": {
"name": "<string>",
"interval": "DAY",
"count": 2154
},
"status": "DRAFT",
"currency": "USD",
"type": "<string>",
"maxNewQuoteDate": 2154,
"activatedWithReason": "DEFAULT_PRICING",
"items": [
{
"cycle": {
"name": "<string>",
"interval": "DAY",
"count": 2154
},
"chargeType": "METERED",
"chargeElement": "<string>",
"tiersMode": "GRADUATED",
"chargeElementAggregationType": "LATEST",
"transformQuantity": {
"divideBy": 28,
"round": "UP"
},
"tiers": [
{
"floor": 2154,
"ceiling": 2154,
"unitAmount": 42,
"unitAmountDecimal": "<string>",
"flatAmount": 47
}
],
"prorateOnUsageChange": "CREATE_PRORATIONS",
"prorationBehaviour": {
"onExceeding": "CREATE_PRORATIONS",
"hasRemediationPeriod": true
}
}
],
"version": 2154,
"relationships": [
{
"fromPricingPlanKey": "<string>",
"toPricingPlanKey": "<string>",
"fromPricingPlanId": "<string>",
"toPricingPlanId": "<string>",
"type": "ADVANTAGE_PRICING",
"metadata": {}
}
],
"supportedBillingSystems": [
"HAMS"
],
"activationDate": 2154,
"createdBy": "<string>",
"managedBy": "<string>",
"catalogAccountId": "<string>"
}List all pricing plans under the provided offering key
Rate limit: 600 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
array<string>
integer
string
OK
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/commerce/api/v2/offerings/{offeringId}/pricing-plans' \
--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
{
"values": [
{
"id": "<string>",
"updatedAt": 2154,
"description": "<string>",
"offeringId": "<string>",
"productId": "<string>",
"offeringName": "<string>",
"ari": "<string>",
"primaryCycle": {
"name": "<string>",
"interval": "DAY",
"count": 2154
},
"status": "DRAFT",
"currency": "USD",
"type": "<string>",
"maxNewQuoteDate": 2154,
"activatedWithReason": "DEFAULT_PRICING",
"items": [
{
"cycle": {
"name": "<string>",
"interval": "DAY"
},
"chargeType": "METERED",
"chargeElement": "<string>",
"tiersMode": "GRADUATED",
"chargeElementAggregationType": "LATEST",
"transformQuantity": {
"divideBy": 28,
"round": "UP"
},
"tiers": [
{
"floor": 2154
}
],
"prorateOnUsageChange": "CREATE_PRORATIONS",
"prorationBehaviour": {
"onExceeding": "CREATE_PRORATIONS"
}
}
],
"version": 2154,
"relationships": [
{
"fromPricingPlanKey": "<string>",
"toPricingPlanKey": "<string>",
"fromPricingPlanId": "<string>",
"toPricingPlanId": "<string>",
"type": "ADVANTAGE_PRICING",
"metadata": {}
}
],
"supportedBillingSystems": [
"HAMS"
],
"activationDate": 2154,
"createdBy": "<string>",
"managedBy": "<string>",
"catalogAccountId": "<string>"
}
],
"nextId": "<string>"
}Delete a pricing plan
Rate limit: 100 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
No Content
1
2
curl --request DELETE \
--url 'https://api.atlassian.com/commerce/api/v1/pricing-plans/{id}'Rate limit: 100 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/v2/pricing-changes/{pricingChangeId}' \
--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
{
"id": "<string>",
"offeringId": "<string>",
"offeringChangeId": "<string>",
"description": "<string>",
"ari": "<string>",
"changes": [
{
"activate": {
"pricingPlanId": "<string>",
"activationReasonCode": "DEFAULT_PRICING"
},
"deactivate": {
"pricingPlanId": "<string>",
"maxNewQuoteDate": 2154
},
"migrate": {
"fromPricingPlanId": "<string>",
"destinations": [
{}
]
}
}
],
"effectiveDate": 2154,
"catalogAccountId": "<string>",
"createdAt": 2154,
"createdBy": "<string>",
"updatedAt": 2154,
"updatedBy": "<string>",
"version": 2154,
"status": "DRAFT"
}Rate limit: 100 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
array<Offerings_PublicChangeInput>
integer
DeprecatedOK
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
curl --request PUT \
--url 'https://api.atlassian.com/commerce/api/v2/pricing-changes/{pricingChangeId}' \
--header 'Accept: application/json' \
--header 'X-Catalog-Account: <X-Catalog-Account>' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"changes": [
{
"activate": {
"pricingPlanId": "<string>",
"activationReasonCode": "DEFAULT_PRICING"
},
"deactivate": {
"pricingPlanId": "<string>",
"maxNewQuoteDate": 88
},
"migrate": {
"fromPricingPlanId": "<string>",
"destinations": [
{
"cohort": {}
}
]
}
}
],
"effectiveDate": 83
}'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
{
"id": "<string>",
"offeringId": "<string>",
"offeringChangeId": "<string>",
"description": "<string>",
"ari": "<string>",
"changes": [
{
"activate": {
"pricingPlanId": "<string>",
"activationReasonCode": "DEFAULT_PRICING"
},
"deactivate": {
"pricingPlanId": "<string>",
"maxNewQuoteDate": 2154
},
"migrate": {
"fromPricingPlanId": "<string>",
"destinations": [
{}
]
}
}
],
"effectiveDate": 2154,
"catalogAccountId": "<string>",
"createdAt": 2154,
"createdBy": "<string>",
"updatedAt": 2154,
"updatedBy": "<string>",
"version": 2154,
"status": "DRAFT"
}Rate limit: 100 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
string
string
array<Offerings_PublicChangeInput>
Requiredinteger
DeprecatedOK
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
curl --request POST \
--url 'https://api.atlassian.com/commerce/api/v2/pricing-changes' \
--header 'Accept: application/json' \
--header 'X-Catalog-Account: <X-Catalog-Account>' \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"offeringId": "<string>",
"offeringChangeId": "<string>",
"description": "<string>",
"changes": [
{
"activate": {
"pricingPlanId": "<string>",
"activationReasonCode": "DEFAULT_PRICING"
},
"deactivate": {
"pricingPlanId": "<string>",
"maxNewQuoteDate": 88
},
"migrate": {
"fromPricingPlanId": "<string>",
"destinations": [
{
"cohort": {}
}
]
}
}
],
"effectiveDate": 44
}'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
{
"id": "<string>",
"offeringId": "<string>",
"offeringChangeId": "<string>",
"description": "<string>",
"ari": "<string>",
"changes": [
{
"activate": {
"pricingPlanId": "<string>",
"activationReasonCode": "DEFAULT_PRICING"
},
"deactivate": {
"pricingPlanId": "<string>",
"maxNewQuoteDate": 2154
},
"migrate": {
"fromPricingPlanId": "<string>",
"destinations": [
{}
]
}
}
],
"effectiveDate": 2154,
"catalogAccountId": "<string>",
"createdAt": 2154,
"createdBy": "<string>",
"updatedAt": 2154,
"updatedBy": "<string>",
"version": 2154,
"status": "DRAFT"
}Rate limit: 100 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredNo Content
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/commerce/api/v1/pricing-changes/{pricingChangeId}' \
--header 'X-Catalog-Account: <X-Catalog-Account>'Rate limit: 100 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredinteger
Accepted
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'https://api.atlassian.com/commerce/api/v2/pricing-changes/{pricingChangeId}/execute' \
--header 'Accept: application/json' \
--header 'X-Catalog-Account: <X-Catalog-Account>' \
--header 'Content-Type: application/json' \
--data '{
"effectiveDate": 43
}'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
{
"id": "<string>",
"offeringId": "<string>",
"offeringChangeId": "<string>",
"description": "<string>",
"ari": "<string>",
"changes": [
{
"activate": {
"pricingPlanId": "<string>",
"activationReasonCode": "DEFAULT_PRICING"
},
"deactivate": {
"pricingPlanId": "<string>",
"maxNewQuoteDate": 2154
},
"migrate": {
"fromPricingPlanId": "<string>",
"destinations": [
{}
]
}
}
],
"effectiveDate": 2154,
"catalogAccountId": "<string>",
"createdAt": 2154,
"createdBy": "<string>",
"updatedAt": 2154,
"updatedBy": "<string>",
"version": 2154,
"status": "DRAFT"
}Rate limit: 100 requests per minute.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
Requiredstring
Requiredstring
Requiredarray<PublicPricingPlanItemInput>
OK
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
curl --request POST \
--url 'https://api.atlassian.com/commerce/api/v2/pricing-plans' \
--header 'Accept: application/json' \
--header 'X-Catalog-Account: <X-Catalog-Account>' \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"offeringId": "<string>",
"primaryCycleId": "<string>",
"currency": "<string>",
"items": [
{
"cycleId": "<string>",
"starter": true,
"chargeType": "<string>",
"chargeElement": "<string>",
"tiersMode": "<string>",
"prorateOnUsageChange": "<string>",
"prorationBehaviour": {
"onExceeding": "<string>",
"hasRemediationPeriod": true
},
"chargeElementAggregationType": "<string>",
"transformQuantity": {
"divideBy": 28,
"round": "<string>"
},
"tiers": [
{
"floor": 40,
"ceiling": 40,
"unitAmount": 31,
"unitAmountDecimal": "<string>",
"flatAmount": 31
}
]
}
]
}'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
{
"id": "<string>",
"updatedAt": 2154,
"description": "<string>",
"offeringId": "<string>",
"productId": "<string>",
"offeringName": "<string>",
"ari": "<string>",
"primaryCycle": {
"name": "<string>",
"interval": "DAY",
"count": 2154
},
"status": "DRAFT",
"currency": "USD",
"type": "<string>",
"maxNewQuoteDate": 2154,
"activatedWithReason": "DEFAULT_PRICING",
"items": [
{
"cycle": {
"name": "<string>",
"interval": "DAY",
"count": 2154
},
"chargeType": "METERED",
"chargeElement": "<string>",
"tiersMode": "GRADUATED",
"chargeElementAggregationType": "LATEST",
"transformQuantity": {
"divideBy": 28,
"round": "UP"
},
"tiers": [
{
"floor": 2154,
"ceiling": 2154,
"unitAmount": 42,
"unitAmountDecimal": "<string>",
"flatAmount": 47
}
],
"prorateOnUsageChange": "CREATE_PRORATIONS",
"prorationBehaviour": {
"onExceeding": "CREATE_PRORATIONS",
"hasRemediationPeriod": true
}
}
],
"version": 2154,
"relationships": [
{
"fromPricingPlanKey": "<string>",
"toPricingPlanKey": "<string>",
"fromPricingPlanId": "<string>",
"toPricingPlanId": "<string>",
"type": "ADVANTAGE_PRICING",
"metadata": {}
}
],
"supportedBillingSystems": [
"HAMS"
],
"activationDate": 2154,
"createdBy": "<string>",
"managedBy": "<string>",
"catalogAccountId": "<string>"
}Rate this page: