Create contract phase

Create a new phase for an existing contract

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string
required
Defaults to Standard Phase

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

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

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.

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

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

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

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

enum

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

phase_metadata

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

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json