Get a quote by resource ID

GET

/v:version/quotes/:resourceId

GET

/v:version/quotes/:resourceId

1 curl https://test.api.solvimon.com/v1/quotes/ \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json"

1 {
2   "customer_id": "cus_9876543210fedcba",
3   "description": "Quote for annual software subscription",
4   "contact_id": "cont_1234567890abcdef",
5   "owner_user_id": "usr_abcdef1234567890",
6   "object_type": "quote",
7   "id": "qte_1234567890abcdef",
8   "created_at": "2024-05-20T10:15:30Z",
9   "updated_at": "2024-05-22T14:45:00Z",
10   "status": "APPROVED",
11   "customer": {
12     "reference": "CUST-2023-0001",
13     "type": "ORGANIZATION",
14     "email": "contact@acmecorp.com",
15     "roles": [
16       "DEFAULT"
17     ],
18     "object_type": "customer",
19     "id": "cus_9876543210fedcba",
20     "created_at": "2023-11-10T08:00:00Z",
21     "parent_customer_id": "cus_parent_001",
22     "parent_customer_ids": [
23       "cus_parent_001",
24       "cus_grandparent_002"
25     ],
26     "status": "ACTIVE",
27     "timezone": "America/New_York",
28     "notification_preferences": [
29       {
30         "type": "INVOICE",
31         "channels": [
32           {
33             "type": "EMAIL",
34             "enabled": true
35           }
36         ]
37       }
38     ],
39     "locale": "en-US",
40     "individual": {
41       "name": {
42         "first_name": "John",
43         "last_name": "Doe",
44         "infix": ""
45       },
46       "residential_address": {
47         "line1": "123 Maple Street",
48         "line2": "Apt 4B",
49         "city": "Springfield",
50         "postal_code": "01103",
51         "state": "MA",
52         "country": "US"
53       }
54     },
55     "organization": {
56       "legal_name": "Acme Corporation",
57       "tax_id": "12-3456789",
58       "tax_ids": [
59         {
60           "id": "12-3456789",
61           "type": "EIN"
62         }
63       ],
64       "registration_number": "REG-2023-ACME",
65       "tax_exempt": false,
66       "tax_exempt_note": "",
67       "registered_address": {
68         "line1": "456 Industrial Way",
69         "line2": "",
70         "city": "Springfield",
71         "postal_code": "01104",
72         "state": "MA",
73         "country": "US"
74       }
75     },
76     "custom_fields": [
77       {
78         "id": "cf_001",
79         "reference": "preferred_contact_method",
80         "value": "email",
81         "values": [
82           "email",
83           "phone"
84         ],
85         "integration_details": {
86           "payment_gateway_variant": "STRIPE",
87           "id": "int_001",
88           "reference": "stripe_gateway",
89           "adyen": {
90             "recurring_detail_reference": ""
91           },
92           "stripe": {
93             "payment_method_id": "pm_1GqIC8Lz0qyl6XeW3xYz1234"
94           }
95         }
96       }
97     ],
98     "processing_only": false,
99     "pricing_plan_subscription_selector": {
100       "data": [
101         {
102           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
103           "value": "US"
104         }
105       ],
106       "rules": [
107         {
108           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
109           "type": "EQUALS"
110         }
111       ],
112       "filters": [
113         {
114           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
115           "type": "EQUALS",
116           "value": "US"
117         }
118       ],
119       "fallback": "LATEST"
120     },
121     "linked_integrations": [
122       {
123         "id": "int_002",
124         "link_details": [
125           {
126             "url": "https://dashboard.stripe.com/customers/cus_9876543210fedcba",
127             "custom_field_name": "stripe_customer_link"
128           }
129         ]
130       }
131     ]
132   },
133   "owner_user": {
134     "username": "jdoe",
135     "object_type": "user",
136     "id": "usr_abcdef1234567890",
137     "entity_id": "ent_001",
138     "created_at": "2022-09-15T12:00:00Z",
139     "status": "ACTIVE",
140     "password": "********",
141     "invite_expired": false,
142     "active": true,
143     "account_memberships": [
144       {
145         "account_id": "acc_001",
146         "type": "ADMIN",
147         "role_ids": [
148           "role_admin_001"
149         ],
150         "object_type": "account_membership",
151         "id": "am_001",
152         "account": {
153           "id": "acc_001",
154           "reference": "ACME-ACC-001",
155           "account_type_code": "BUSINESS",
156           "environment": "production",
157           "account_group_id": "ag_001",
158           "parent_id": "acc_parent_001",
159           "platform_id": "platform_001"
160         },
161         "account_reference": "ACME-ACC-001",
162         "environment": "production",
163         "roles": [
164           {
165             "name": "Administrator",
166             "description": "Full access to all system features",
167             "child_role_ids": [
168               "role_subadmin_002"
169             ],
170             "object_type": "role",
171             "id": "role_admin_001",
172             "entity_id": "ent_001",
173             "child_roles": [
174               {}
175             ]
176           }
177         ]
178       }
179     ],
180     "team_memberships": [
181       {
182         "team_id": "team_001",
183         "start_at": "2023-01-01T09:00:00Z",
184         "end_at": "2024-12-31T17:00:00Z",
185         "account_memberships": [
186           {
187             "account_id": "acc_002",
188             "type": "ADMIN",
189             "role_ids": [
190               "role_manager_003"
191             ],
192             "object_type": "account_membership",
193             "id": "am_002",
194             "account": {
195               "id": "acc_002",
196               "reference": "ACME-ACC-002",
197               "account_type_code": "BUSINESS",
198               "environment": "production",
199               "account_group_id": "ag_002",
200               "parent_id": "acc_parent_002",
201               "platform_id": "platform_002"
202             },
203             "account_reference": "ACME-ACC-002",
204             "environment": "production",
205             "roles": [
206               {
207                 "name": "Manager",
208                 "description": "Manage team and projects",
209                 "child_role_ids": [
210                   "role_assistant_004"
211                 ],
212                 "object_type": "role",
213                 "id": "role_manager_003",
214                 "entity_id": "ent_002",
215                 "child_roles": [
216                   {}
217                 ]
218               }
219             ]
220           }
221         ]
222       }
223     ]
224   },
225   "quote_version_infos": [
226     {
227       "version": 1,
228       "id": "qv_001",
229       "status": "FINALIZED",
230       "pricing_plan_subscription_id": "pps_001"
231     }
232   ]
233 }

Requires the QUOTE.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Query parameters

expand[]list of stringsOptional

The id fields of the resources that are going to be expanded.

Response

customer_idstring

The ID of the customer.

descriptionstring

The description of the quote.

contact_idstring

The contact details for the quote.

owner_user_idstring

The ID of the user that is owning/ creating the quote.

object_typestring or nullRead-only

idstring or nullRead-only

created_atstring or nullRead-only

updated_atstring or nullRead-only

statusstring or nullRead-only

customerobject or null

owner_userobject or null

quote_version_infoslist of objects or nullRead-only

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors