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

Quotes

Postman Collection
OpenAPI

A quote is a legally non-binding offer of products or services typically sent to a customer for consideration before making a buying decision.

GET

Get quote 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

GetQuoteResponseV2
GET/v2/quotes/{id}
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/quotes/{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 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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 { "id": "<string>", "name": "<string>", "version": 31, "contractType": "STANDARD", "clonedFrom": "<string>", "number": "<string>", "expiresAt": 56, "expiresAfterDays": 75, "fromQuote": "<string>", "revision": 41, "locale": "<string>", "transactionAccountId": "<string>", "reasonCode": "<string>", "invoiceGroupId": "<string>", "status": "VALIDATION_IN_PROGRESS", "externalNotes": [ { "note": "<string>", "createdAt": 2154 } ], "createdBy": { "subject": "<string>", "subjectType": "<string>", "isCustomerAdvocate": true, "isSystemDrivenAction": true }, "createdAt": 41, "updatedBy": { "subject": "<string>", "subjectType": "<string>", "isCustomerAdvocate": true, "isSystemDrivenAction": true }, "updatedAt": 46, "lineItems": [ { "lineItemId": "<string>", "entitlementId": "<string>", "entitlementVersion": "<string>", "lineItemType": "CREATE_ENTITLEMENT", "offeringKey": "<string>", "pricingPlanId": "<string>", "chargeQuantities": [ { "chargeElement": "<string>", "quantity": 2154 } ], "promotions": [ { "promotionInstanceId": "<string>", "promotionDefinition": {} } ], "relatesFromEntitlements": [ { "referenceType": "ENTITLEMENT", "entitlementId": "<string>", "lineItemId": "<string>", "relationshipType": "<string>" } ], "lockContext": { "isPriceLocked": true, "isPromotionLocked": true }, "skipTrial": true, "orderItemId": "<string>", "subscriptionId": "<string>", "startsAt": { "type": "QUOTE_ACCEPTANCE_DATE", "timestamp": 60 }, "billingAnchor": { "type": "QUOTE_ACCEPTANCE_DATE", "timestamp": 37 }, "endsAt": { "type": "DURATION", "duration": { "interval": "YEAR", "intervalCount": 42 }, "timestamp": 37 }, "status": "STALE", "staleReason": { "code": "<string>", "name": "<string>", "lastUpdatedAt": 54, "orderId": "<string>", "orderItemId": "<string>" }, "cancelledReason": { "code": "<string>", "name": "<string>", "lastUpdatedAt": 54, "orderId": "<string>", "orderItemId": "<string>" }, "preBillingConfiguration": { "billFrom": { "type": "QUOTE_ACCEPTANCE_DATE" }, "billTo": { "type": "DURATION" } }, "metadata": {} } ], "metadata": {}, "finalizedAt": 66, "staleReason": { "code": "<string>", "name": "<string>", "lastUpdatedAt": 54, "expiresAt": 37, "orderId": "<string>", "orderItemId": "<string>" }, "cancelledReason": { "code": "<string>", "name": "<string>", "lastUpdatedAt": 54, "orderId": "<string>", "orderItemId": "<string>" }, "upcomingBillsRequestedAt": 49, "upcomingBillsComputedAt": 48, "upcomingBills": { "tax": 46, "total": 33, "subTotal": 60, "lines": [ { "id": "<string>", "quoteLineId": "<string>", "description": "<string>", "currency": "USD", "total": 25, "subTotal": 67, "tax": 37, "period": {}, "offeringId": "<string>", "pricingPlanId": "<string>", "quantity": 43, "adjustments": [ {} ], "margins": [ {} ], "taxItems": [ {} ], "taxPercent": 41, "metadata": {} } ] }, "autoRefresh": { "initiatedAt": 71, "reason": "<string>" } }
GET

Get Quotes for a Transaction Account ID

Rate limit: 600 requests per minute.

Request

Query parameters

page-size

integer

start-id

string

status-filter

string

invoice-group

string

Header parameters

X-transaction-account

string

Required

Responses

OK

*/*

PublicPaginatedQuotesEntityGetQuoteResponseV2String
GET/v1/quotes
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v1/quotes' \ --header 'Accept: */*'
GET

Download PDF for a Quote ID

Rate limit: 600 requests per minute.

Request

Path parameters

id

string

Required

Query parameters

transactionAccountId

string

Required

Responses

OK

application/pdf

string

GET/v3/quotes/{id}/download
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v3/quotes/{id}/download?transactionAccountId={transactionAccountId}' \ --header 'Accept: application/pdf'

Rate this page: