Skip to main content
POST
Add a quote phase

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version
enum<string>
required
Available options:
2026-04-01
Idempotency-Key
string

A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.

Maximum string length: 255
Example:

"ik_a1b2c3d4e5f6"

Path Parameters

id
string
required

Unique identifier for the quote

Body

application/json
items
object[]
required

Complete set of priced items for this phase.

Maximum array length: 200
description
string | null

Human-readable note on the phase

Example:

"Year 2 step-up"

start_date
string<date> | null

When the phase starts (YYYY-MM-DD). Alternative to start_month_offset.

Example:

"2027-01-01"

start_month_offset
integer<int64> | null

Months after the billing start when the phase begins; resolved into a date at signature. Alternative to start_date.

Required range: 0 <= x <= 1200
Example:

12

Response

Success

acv
string
required

Annual contract value

Example:

"6000.00"

arr
string
required

Annual recurring revenue

Example:

"6000.00"

currency
string
required

ISO 4217 currency code

Example:

"USD"

id
string
required

Phase ID. This is the subscription version the phase becomes: after signature the same row is readable at /subscriptions/{subscription_id}/versions/{id}.

Example:

"subv_abc123"

mrr
string
required

Monthly recurring revenue

Example:

"500.00"

quote_id
string
required

Quote ID

Example:

"qt_abc123"

sequence
integer<int64>
required

Position in the quote's schedule, from 1. Positional, not an identifier: deleting a phase renumbers the rest, so address a phase by id.

Example:

1

description
string | null

Note on the phase

Example:

"Year 2 step-up"

end_date
string<date-time> | null

When the phase ends

Example:

"2027-10-01T00:00:00Z"

plan_id
string | null

Plan the phase was seeded from

Example:

"pln_abc123"

start_date
string<date-time> | null

When the phase starts; null for an undated ramp phase until signature

Example:

"2026-10-01T00:00:00Z"

start_month_offset
integer<int64> | null

Months after the billing start when an undated phase begins

Example:

12

tcv
string | null

Total contract value of the phase over its term; null when no term is knowable

Example:

"6000.00"