Skip to main content
PATCH
Update a quote

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
clear_expires_at
boolean

Make the signing offer open-ended.

clear_name
boolean

Drop the override, falling back to the subscription's name.

expires_at
string<date-time> | null

Move the signing deadline. Ignored when clear_expires_at is true.

Example:

"2026-09-30T23:59:59Z"

name
string | null

Name override for this quote. Does not rename the subscription. Ignored when clear_name is true.

Example:

"Acme Platform 2026 (revised)"

Response

Success

auto_activate
boolean
required

Whether this quote takes effect on its own once signed; otherwise activate it with Activate a Signed Quote

Example:

false

contract
object
required

Term of the subscription this quote documents

created_at
string<date-time>
required

When the quote was created

Example:

"2026-08-21T10:00:00Z"

currency
string
required

ISO 4217 currency code

Example:

"USD"

customer_id
string
required

Customer ID

Example:

"cust_abc123"

id
string
required

Quote ID

Example:

"qt_abc123"

kind
enum<string>
required

Quote kind

Available options:
new,
renewal,
amendment
Example:

"new"

name
string
required

Display name of the quote: its own override when one is set, otherwise the name of the subscription it documents

Example:

"Acme Platform 2026"

status
enum<string>
required

Document status

Available options:
draft,
pending_approval,
sent,
signed,
rejected,
withdrawn,
expired
Example:

"draft"

subscription_id
string
required

The subscription this quote creates or amends. Whether the deal is in effect is that subscription's state, not the quote's: read it, or its phases, once the quote is signed.

Example:

"sub_abc123"

updated_at
string<date-time>
required

When the quote was last updated

Example:

"2026-08-21T10:00:00Z"

expires_at
string<date-time> | null

When the signing offer expires; null means it never expires

Example:

"2026-09-30T23:59:59Z"

signing_url
string | null

Hosted page where the customer reviews and signs. Present on a single quote while a customer signature is pending, so a lost link can be recovered; omitted on the list.

Example:

"https://acme.alguna.io/hs/elt_abc123"

withdrawal_reason
string | null

Reason recorded on withdrawal

Example:

"Superseded by revised terms"

withdrawn_at
string<date-time> | null

When the quote was withdrawn, if withdrawn

Example:

"2026-09-15T09:00:00Z"