Skip to navigation

Create a quote pricing plan subscription together with a pricing plan schedule, or several in pricing_plan_subscriptions, each with its schedule, for the customer of the quote and its children

Requires the QUOTE.CREATE permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
quoteobjectOptional
quote_versionobjectOptional
pricing_plan_subscriptionobjectOptional
pricing_plan_scheduleobjectOptional
quote_template_idstring or nullOptional
The ID of the quote template to initialize the quote from, if creating from a template.
pricing_plan_subscriptionslist of objects or nullOptional

The pricing plan subscriptions of the quote version, each with its schedule: those of the quote’s customer and of its children. An alternative to pricing_plan_subscription and pricing_plan_schedule; a list of one gives the same result as the single form. In the response both are filled: pricing_plan_subscription and pricing_plan_schedule hold the first entry.

Response

Created
quoteobjectOptional
quote_versionobjectOptional
pricing_plan_subscriptionobjectOptional
pricing_plan_scheduleobjectOptional
quote_template_idstring or nullOptional
The ID of the quote template to initialize the quote from, if creating from a template.
pricing_plan_subscriptionslist of objects or nullOptional

The pricing plan subscriptions of the quote version, each with its schedule: those of the quote’s customer and of its children. An alternative to pricing_plan_subscription and pricing_plan_schedule; a list of one gives the same result as the single form. In the response both are filled: pricing_plan_subscription and pricing_plan_schedule hold the first entry.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error