Skip to main content
POST
Create contract phase pricing

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

contract_id
string<uuid>
required
phase_id
string<uuid>
required

Body

application/json
external_id
string | null

External ID

start_date
string<date-time> | null

Start Date

end_date
string<date-time> | null

End Date

anchor_date
string<date-time> | null

Anchor Date

pricing_id
string<uuid> | null
default:6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3

Pricing ID

product_id
string<uuid> | null
default:c19a0ece-63c3-412b-8549-e722bc28605d

Product ID

custom_data
Custom Data · object | null

Pricing Association Metadata

pricing
CreateProductPricingRequestSchema · object | null

Pricing for the phase

product
Create Product Request V1 · object | null

Product Name

plan_id
string<uuid> | null

Plan ID - reference to the plan_v3 this pricing is associated with

description
string | null

Line item description for this pricing association. Overrides pricing and product descriptions if provided.

Response

Successful Response

id
string<uuid>
required

Contract Phase Pricing ID

phase_id
string<uuid>
required

Contract Phase ID

pricing_id
string<uuid>
required

Pricing ID

product_id
string<uuid>
required

Product ID

created_at
string<date-time>
required

Contract Phase Pricing created at

updated_at
string<date-time>
required

Contract Phase Pricing updated at

product
ProductResponseSchema · object
required

Product details

pricing
ProductBundlePricingResponseSchema · object
required

Pricing details (with overrides applied)

external_id
string | null

External ID

start_date
string<date-time> | null

Start Date

end_date
string<date-time> | null

End Date

anchor_date
string<date-time> | null

Anchor Date

custom_data
Custom Data · object | null

Pricing Association Metadata

plan_id
string<uuid> | null

Plan ID - reference to the plan_v3 this pricing is associated with

description
string | null

Line item description for this pricing association. Overrides pricing and product descriptions if provided.

resolved_description
string | null

Effective description resolved from the fallback chain: description > pricing.description > product.description

is_optional
boolean
default:false

When True, customers can enable/disable this line item in self-serve checkout

is_enabled
EnabledEntry · object[]

Schedule of enable/disable states for this line item over time