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

Orders

Postman Collection
OpenAPI

An order is an entity representing a user's intent to create, amend, or delete a contract to provide the enumerated service from a billing perspective.

GET

Get order by ID

Rate limit: 600 requests per minute.

Request

Path parameters

id

string

Required

Header parameters

X-transaction-account

string

Required

Responses

OK

application/json

OrderGetResponseDtoV2
GET/v2/orders/{id}
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/orders/{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 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 { "orderId": "<string>", "slug": "<string>", "transactionAccountId": "<string>", "invoiceGroupId": "<string>", "items": [ { "offeringId": "<string>", "orderItemId": "<string>", "optedUsageOptions": { "chargingDetails": {}, "trial": {}, "billingBehaviour": { "type": "PAUSE_BILLING" }, "effectiveTime": { "endsAt": { "type": "TIMESTAMP" } } }, "type": "CREATION_ORDER", "processingInfo": { "status": "PROCESSING", "entitlement": { "id": "<string>", "version": "<string>" }, "transitionTimestamp": 2154, "transitionTime": "IMMEDIATE", "saleTransitionDetails": {}, "saleTransitionType": "NEW", "computedDetails": {}, "accountModification": {}, "additionalTriggeredOrderItems": [ {} ], "prorationBehaviour": "NONE", "impactedEntitlements": [ {} ] }, "billingOptions": { "preBill": { "billUntil": { "type": "TIMESTAMP_REFERENCE" } } }, "resetOptions": { "resetType": "HARD_RESET", "backdateTimestamp": 2154, "resetGLPOrderItemId": "<string>", "invoiceRequestId": "<string>" }, "reasonCode": "<string>", "metadata": {}, "triggeredByOrderItem": { "orderId": "<string>", "orderItemId": "<string>" }, "promotions": [ { "promotionInstanceId": "<string>", "promotionDefinition": {} } ], "isImmediate": true, "originalOrderItemId": "<string>", "quoteLineItemDetailsReference": { "quoteId": "<string>", "version": 2154, "quoteLineItemId": "<string>" }, "subscriptionStartTime": 2154, "transition": { "offering": {}, "pricingPlan": {}, "applyAfterTimestamp": 2154 }, "rewindToOrderItemId": "<string>", "billingAnchorTime": 2154, "nextBillingAnchorTimestamp": 2154, "backdateTimestamp": 2154, "rebillOptions": { "billFromTimestamp": 2154 }, "prorationBehaviour": "NONE", "relatesFromEntitlements": [ {} ] } ], "additionalTriggeredOrders": [], "createdDate": 2154 }
GET

Get order item by ID

Rate limit: 600 requests per minute.

Request

Path parameters

orderId

string

Required
orderItemId

string

Required

Header parameters

X-transaction-account

string

Required

Responses

OK

application/json

OrderGetResponseDtoV2
GET/v2/orders/{orderId}/orderItem/{orderItemId}
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/orders/{orderId}/orderItem/{orderItemId}' \ --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 { "orderId": "<string>", "slug": "<string>", "transactionAccountId": "<string>", "invoiceGroupId": "<string>", "items": [ { "offeringId": "<string>", "orderItemId": "<string>", "optedUsageOptions": { "chargingDetails": {}, "trial": {}, "billingBehaviour": { "type": "PAUSE_BILLING" }, "effectiveTime": { "endsAt": { "type": "TIMESTAMP" } } }, "type": "CREATION_ORDER", "processingInfo": { "status": "PROCESSING", "entitlement": { "id": "<string>", "version": "<string>" }, "transitionTimestamp": 2154, "transitionTime": "IMMEDIATE", "saleTransitionDetails": {}, "saleTransitionType": "NEW", "computedDetails": {}, "accountModification": {}, "additionalTriggeredOrderItems": [ {} ], "prorationBehaviour": "NONE", "impactedEntitlements": [ {} ] }, "billingOptions": { "preBill": { "billUntil": { "type": "TIMESTAMP_REFERENCE" } } }, "resetOptions": { "resetType": "HARD_RESET", "backdateTimestamp": 2154, "resetGLPOrderItemId": "<string>", "invoiceRequestId": "<string>" }, "reasonCode": "<string>", "metadata": {}, "triggeredByOrderItem": { "orderId": "<string>", "orderItemId": "<string>" }, "promotions": [ { "promotionInstanceId": "<string>", "promotionDefinition": {} } ], "isImmediate": true, "originalOrderItemId": "<string>", "quoteLineItemDetailsReference": { "quoteId": "<string>", "version": 2154, "quoteLineItemId": "<string>" }, "subscriptionStartTime": 2154, "transition": { "offering": {}, "pricingPlan": {}, "applyAfterTimestamp": 2154 }, "rewindToOrderItemId": "<string>", "billingAnchorTime": 2154, "nextBillingAnchorTimestamp": 2154, "backdateTimestamp": 2154, "rebillOptions": { "billFromTimestamp": 2154 }, "prorationBehaviour": "NONE", "relatesFromEntitlements": [ {} ] } ], "additionalTriggeredOrders": [], "createdDate": 2154 }
GET

Get orders for a transaction account ID

Rate limit: 600 requests per minute.

Request

Query parameters

page-size

integer

start-id

string

invoice-group

string

Header parameters

X-transaction-account

string

Required

Responses

OK

application/json

PaginatedDataResponseDtoOrderGetResponseDtoV2String
GET/v2/orders
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/orders' \ --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 { "data": [ { "orderId": "<string>", "slug": "<string>", "transactionAccountId": "<string>", "invoiceGroupId": "<string>", "items": [ { "offeringId": "<string>", "orderItemId": "<string>", "optedUsageOptions": {}, "type": "CREATION_ORDER", "processingInfo": {}, "billingOptions": {}, "resetOptions": { "resetType": "HARD_RESET", "resetGLPOrderItemId": "<string>" }, "reasonCode": "<string>", "metadata": {}, "triggeredByOrderItem": {}, "promotions": [ {} ], "isImmediate": true, "originalOrderItemId": "<string>", "quoteLineItemDetailsReference": {}, "subscriptionStartTime": 2154, "transition": { "offering": {} }, "rewindToOrderItemId": "<string>", "billingAnchorTime": 2154, "nextBillingAnchorTimestamp": 2154, "backdateTimestamp": 2154, "rebillOptions": {}, "prorationBehaviour": "NONE", "relatesFromEntitlements": [ {} ] } ], "additionalTriggeredOrders": [], "createdDate": 2154 } ], "nextId": "<string>" }

Rate this page: