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

Offerings

Postman Collection
OpenAPI

An offering represents a packaging of a product that'll result in an entitlement.

Operations
GET/v3/offerings/{id}GET/v1/offerings/{id}/related/{type}GET/v2/products/{productId}/offerings
GET

Get offering by ID

Rate limit: 900 requests per minute.

Request

Path parameters

id

string

Required

Responses

OK

application/json

PublicOfferingResponse
GET/v3/offerings/{id}
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v3/offerings/{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 { "id": "<string>", "name": "<string>", "ari": "<string>", "updatedAt": 2154, "hostingType": "CLOUD", "level": 131, "productId": "<string>", "slugs": [ "<string>" ], "pricingType": "EXTERNAL", "status": "DRAFT", "supportedBillingSystems": [ "HAMS" ], "version": 2154, "chargeElements": {}, "expiryDate": 2154, "trial": { "lengthDays": 2154 }, "offeringGroup": { "id": "<string>", "name": "<string>", "slug": "<string>", "level": 74, "productId": "<string>" } }
GET

Rate limit: 600 requests per minute.

id

string

Required
type

string

Required
page-size

integer

start-id

string

OK

application/json

PaginatedResponsePublicOfferingResponse
GET/v1/offerings/{id}/related/{type}
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v1/offerings/{id}/related/{type}' \ --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 { "values": [ { "id": "<string>", "name": "<string>", "ari": "<string>", "updatedAt": 2154, "hostingType": "CLOUD", "level": 131, "productId": "<string>", "slugs": [ "<string>" ], "pricingType": "EXTERNAL", "status": "DRAFT", "supportedBillingSystems": [ "HAMS" ], "version": 2154, "chargeElements": {}, "expiryDate": 2154, "trial": { "lengthDays": 2154 }, "offeringGroup": { "id": "<string>", "name": "<string>", "slug": "<string>", "level": 74, "productId": "<string>" } } ], "nextId": "<string>" }
GET

Get offerings by product

List all offerings under the provided product key

Rate limit: 600 requests per minute.

Request

Path parameters

productId

string

Required

Query parameters

status

string

creation-type

string

page-size

integer

start-id

string

Responses

OK

application/json

PaginatedResponsePublicOfferingResponse
GET/v2/products/{productId}/offerings
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/products/{productId}/offerings' \ --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 { "values": [ { "id": "<string>", "name": "<string>", "ari": "<string>", "updatedAt": 2154, "hostingType": "CLOUD", "level": 131, "productId": "<string>", "slugs": [ "<string>" ], "pricingType": "EXTERNAL", "status": "DRAFT", "supportedBillingSystems": [ "HAMS" ], "version": 2154, "chargeElements": {}, "expiryDate": 2154, "trial": { "lengthDays": 2154 }, "offeringGroup": { "id": "<string>", "name": "<string>", "slug": "<string>", "level": 74, "productId": "<string>" } } ], "nextId": "<string>" }

Rate this page: