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

Entitlements

Postman Collection
OpenAPI

An entitlement is an instantiated offering from the product catalog.

GET

Get entitlement details by ID

Rate limit: 3000 requests per minute.

Request

Path parameters

entitlementId

string

Required

Responses

Fetching Entitlement Details with Limited Fields

application/json

EntitlementDetailsV2
GET/v2/entitlements/{entitlementId}/details
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/entitlements/{entitlementId}/details' \ --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 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 { "entitlementId": "<string>", "invoiceGroupId": "<string>", "version": 2154, "status": "ACTIVE", "slug": "<string>", "offeringKey": "<string>", "entitlementTemplate": { "key": "<string>", "version": 2154, "data": {} }, "featureOverrides": {}, "featureVariables": {}, "transactionAccountId": "<string>", "order": { "id": "<string>", "itemId": "<string>" }, "relatesToEntitlements": [ { "entitlementId": "<string>", "relationshipType": "<string>", "relationshipId": "<string>" } ], "relatesFromEntitlements": [ { "entitlementId": "<string>", "relationshipType": "<string>", "relationshipId": "<string>" } ], "createdAt": 2154, "updatedAt": 2154, "subscription": { "id": "<string>", "billingAnchorTimestamp": 2154, "nextBillingTimestamp": 2154, "nextBillingAnchorTimestamp": 2154, "pricingPlanId": "<string>", "chargeQuantities": [ { "chargeElement": "<string>", "quantity": 2154, "lastUpdatedAt": 2154 } ], "promotionInstances": [ { "promotionInstanceId": "<string>", "promotionDefinition": {} } ], "promotionIds": [ "<string>" ], "invoiceGroupId": "<string>", "startTimestamp": 2154, "endTimestamp": 2154, "status": "PROCESSING", "metadata": {}, "scheduledChanges": { "application": "<string>", "billingBehavior": "<string>", "canceledAt": 2154, "completedAt": 2154, "created": 2154, "currentPhase": {}, "customer": "<string>", "defaultSettings": {}, "endBehavior": "<string>", "id": "<string>", "livemode": true, "metadata": {}, "object": "<string>", "phases": [ {} ], "prebilling": {}, "releasedAt": 2154, "releasedSubscription": "<string>", "status": "<string>", "subscription": "<string>", "testClock": "<string>", "subscriptionObject": {}, "responseGetter": {}, "applicationObject": {}, "customerObject": {}, "testClockObject": {}, "rawJsonObject": {}, "lastResponse": {} }, "trial": { "startTimestamp": 2154, "endTimestamp": 2154, "pricingPlanId": "<string>", "offeringId": "<string>", "endBehaviour": "TRIAL_PLAN" } }, "subscriptionv2": { "id": "<string>", "orderItemId": "<string>", "entitlementId": "<string>", "startTimestamp": 2154, "endTimestamp": 2154, "accountDetails": { "invoiceGroupId": "<string>", "transactionAccountId": "<string>" }, "chargeDetails": { "offeringId": "<string>", "pricingPlanId": "<string>", "chargeQuantities": [ { "chargeElement": "<string>", "quantity": 2154 } ], "promotionInstances": [ {} ] }, "trial": { "startTimestamp": 2154, "endTimestamp": 2154, "pricingPlanId": "<string>", "offeringId": "<string>", "endBehaviour": "TRIAL_PLAN" }, "billingPeriodDetails": { "billingAnchorTimestamp": 36, "nextBillingTimestamp": 34, "nextBillingAnchorTimestamp": 40 }, "scheduledChanges": { "nextCycleChange": {} }, "status": "PROCESSING", "pauseBilling": { "startTimestamp": 28, "endTimestamp": 26 } } }
GET

Get entitlements display info

Rate limit: 600 requests per minute.

Request

Path parameters

entitlementId

string

Required

Header parameters

X-Transaction-Account

string

Responses

OK

application/json

DisplayInfoResponse
GET/v1/entitlements/{entitlementId}/display-info
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v1/entitlements/{entitlementId}/display-info' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 { "entitlementId": "<string>", "provisionedResource": { "ari": "<string>", "name": "<string>" } }