• Products
  • Offerings
  • PricingPlans
  • Invoices
  • InvoiceGroups
  • Orders
  • Quotes
  • Entitlements
Platform
Commerce / Reference / REST API

PricingPlans

Postman Collection
OpenAPI

Pricing plans define how paid offerings are priced and charged for, and result in subscriptions.

GET

Get pricing plan by ID

Rate limit: 900 requests per minute.

Request

Path parameters

id

string

Required

Responses

OK

application/json

PublicPricingPlanResponse
GET/v2/pricing-plans/{id}
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/pricing-plans/{id}' \ --header 'Accept: application/json'
200Response
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 { "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", "tiers": [ { "floor": 2154, "ceiling": 2154, "unitAmount": 42, "flatAmount": 47 } ] } ], "version": 2154, "relationships": [ { "fromPricingPlanKey": "<string>", "toPricingPlanKey": "<string>", "type": "ADVANTAGE_PRICING", "metadata": {} } ], "supportedBillingSystems": [ "HAMS" ], "activationDate": 2154 }
GET

Get pricing plans by offering

List all pricing plans under the provided offering key

Rate limit: 600 requests per minute.

Request

Path parameters

offeringId

string

Required

Query parameters

status

string

activation-reason-code

array<string>

page-size

integer

start-id

string

Responses

OK

application/json

PaginatedResponsePublicPricingPlanResponse
GET/v2/offerings/{offeringId}/pricing-plans
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/offerings/{offeringId}/pricing-plans' \ --header 'Accept: application/json'
200Response
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 { "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", "tiers": [ { "floor": 2154 } ] } ], "version": 2154, "relationships": [ { "fromPricingPlanKey": "<string>", "toPricingPlanKey": "<string>", "type": "ADVANTAGE_PRICING", "metadata": {} } ], "supportedBillingSystems": [ "HAMS" ], "activationDate": 2154 } ], "nextId": "<string>" }