Mark a subscription milestone reached

POST

subscriptions

{id}

milestones

{key}

complete

Mark a subscription milestone reached

curl --request POST \
  --url https://api.alguna.io/subscriptions/{id}/milestones/{key}/complete \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "Shipment DHL-4471",
  "reached_at": "2026-03-10"
}
'

import requests

url = "https://api.alguna.io/subscriptions/{id}/milestones/{key}/complete"

payload = {
    "note": "Shipment DHL-4471",
    "reached_at": "2026-03-10"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({note: 'Shipment DHL-4471', reached_at: '2026-03-10'})
};

fetch('https://api.alguna.io/subscriptions/{id}/milestones/{key}/complete', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "key": "go_live",
  "name": "Go Live",
  "price_ids": [
    "<string>"
  ],
  "status": "pending",
  "subscription_id": "sub_01hz...",
  "completed_at": "2023-11-07T05:31:56Z",
  "completion_source": "dashboard",
  "expected_at": "2023-11-07T05:31:56Z",
  "id": "smst_01hz...",
  "note": "<string>",
  "reached_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

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 that makes a retried write safe. If you send the same request with the same key within 24 hours, the API returns the stored response and does not run the request again. A 5xx or 429 response is not stored, so a retry with that key runs the request again.

Maximum string length: 255

Example:

"ik_a1b2c3d4e5f6"

Path Parameters

string

required

Unique identifier for the subscription

key

string

required

Unique identifier for the milestone

Body

application/json

note

string | null

Free-text note recorded with the completion, such as a shipment reference

Example:

"Shipment DHL-4471"

reached_at

string | null

The date the milestone was reached (YYYY-MM-DD). Defaults to today; may be backdated to the contract start but never set in the future

Example:

"2026-03-10"

Response

Success

key

string

required

Milestone key the subscription's prices reference

Example:

"go_live"

name

string

required

Display name

Example:

"Go Live"

price_ids

string[]

required

The subscription's prices that bill when this milestone is reached

status

enum<string>

required

pending until a completion is recorded, then reached

Available options:

pending,

reached

Example:

"pending"

subscription_id

string

required

Subscription ID

Example:

"sub_01hz..."

completed_at

string<date-time> | null

The day the milestone was declared reached: the invoicing date of the charge

completion_source

enum<string> | null

Which surface declared the milestone reached

Available options:

dashboard,

api

expected_at

string<date-time> | null

When the milestone is expected to be reached; forecasting only

string | null

Milestone record ID, set once the milestone has an expected date or has been reached

Example:

"smst_01hz..."

note

string | null

Note recorded with the completion

reached_at

string<date-time> | null

The day the milestone was reached: the service date on the charge

⌘I

Mark a subscription milestone reached

curl --request POST \
  --url https://api.alguna.io/subscriptions/{id}/milestones/{key}/complete \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "Shipment DHL-4471",
  "reached_at": "2026-03-10"
}
'

import requests

url = "https://api.alguna.io/subscriptions/{id}/milestones/{key}/complete"

payload = {
    "note": "Shipment DHL-4471",
    "reached_at": "2026-03-10"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({note: 'Shipment DHL-4471', reached_at: '2026-03-10'})
};

fetch('https://api.alguna.io/subscriptions/{id}/milestones/{key}/complete', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "key": "go_live",
  "name": "Go Live",
  "price_ids": [
    "<string>"
  ],
  "status": "pending",
  "subscription_id": "sub_01hz...",
  "completed_at": "2023-11-07T05:31:56Z",
  "completion_source": "dashboard",
  "expected_at": "2023-11-07T05:31:56Z",
  "id": "smst_01hz...",
  "note": "<string>",
  "reached_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

API Reference

Examples

SDKs

API Reference

Webhooks

Mark a subscription milestone reached

Authorizations

Headers

Path Parameters

Body

Response