Skip to main content
POST
Create contract phase

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

Body

application/json
name
string
default:Standard Phase
required

Human-readable name for this phase (e.g., 'Trial Period', 'Standard Pricing', 'Promotional Discount'). Used for identification in reports and UI.

description
string | null

Detailed description of what this phase represents, including any special terms, conditions, or business context.

start_date
string<date-time> | null

Date when this phase begins. Must be within contract date boundaries and not overlap with other phases. If not provided, inherits from contract start or previous phase end.

end_date
string<date-time> | null

Date when this phase ends. Must be after start_date and within contract boundaries. If not provided, phase continues until contract end or next phase start.

pricings
CreateContractPhasePricingRequestSchema · object[] | null

List of product-pricing associations for this phase. Each entry links a product with its specific pricing configuration, start/end dates, and any phase-specific terms.

features
CreateProductPricingRequestSchema · object | null

Optional feature pricing configuration applied to all products in this phase. Used for phase-wide features, add-ons, or entitlements.

source_plan_phase_id
string<uuid> | null

Reference to the plan phase template used to create this phase, if applicable. Maintains linkage for plan-based contracts.

phase_type
enum<string> | null

Type of phase indicating its purpose. 'active' for standard billing phases, 'trial' for trial periods, 'paused' for suspended phases.

Available options:
active,
pause,
trial
phase_metadata
Phase Metadata · object | null

Flexible key-value store for phase-specific metadata. Can include campaign codes, discount reasons, or any phase-specific tracking data.

Response

Successful Response

name
string
required

Human-readable name for this phase. Used for identification in reports and UI.

id
string<uuid>
required

Unique identifier for this contract phase

created_at
string<date-time>
required

Timestamp when this phase was created. Used for audit trails.

updated_at
string<date-time>
required

Timestamp of the last modification to this phase or its nested entities.

contract_id
string<uuid>
required

Unique identifier of the parent contract this phase belongs to

description
string | null

Detailed description of what this phase represents, including any special terms or conditions.

start_date
string<date-time> | null

Date when this phase begins. All billing and pricing in this phase start from this date.

end_date
string<date-time> | null

Date when this phase ends. Null indicates this phase continues until contract end or next phase start.

features
ProductPricingResponseSchema · object | null

Feature pricing configuration applied to all products in this phase, if applicable.

pricings
ContractPhasePricingResponseSchema · object[] | null

List of product-pricing associations active during this phase. Each defines a product, its pricing, and any phase-specific terms.

source_plan_phase_id
string<uuid> | null

Reference to the plan phase template used to create this phase, if applicable.

phase_type
enum<string> | null
default:active

Type of phase indicating its purpose (e.g., active, trial, paused).

Available options:
active,
pause,
trial
phase_metadata
Phase Metadata · object | null

Phase-specific metadata stored as key-value pairs. Can include campaign codes, discount reasons, or tracking data.