Subscriptions

Update a subscription

Patches metadata on a subscription: name, description, trial period, billing flags, subscription-level discount, spending thresholds, price escalation, and tags. This endpoint does not modify the priced item set. To change items, see the Updating a Subscription examples. When an edit of a sent subscription saves its terms but the offer is not reissued with them, the call fails with a message that says so and the terms stay saved but cannot be signed; send this request again with an empty body to retry issuing the saved terms.

PATCH

subscriptions

{id}

curl --request PATCH \
  --url https://api.alguna.io/subscriptions/{id} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing": {
    "auto_issue_invoices": true,
    "auto_pay_invoices": false,
    "autopay_timing": "on_due_date",
    "clear_autopay_timing": true,
    "first_billing_date": "2026-07-01",
    "payment_collection_method": "autopay",
    "payment_method_id": "pm_01H1VECT",
    "payment_terms": "net_30"
  },
  "description": "Annual enterprise subscription",
  "discount": {
    "amount": "10",
    "duration_type": "fixed",
    "type": "percentage",
    "duration_unit": "months",
    "duration_value": 6
  },
  "maximum_spend": {
    "amount": "500.00",
    "period": "monthly",
    "billing_direction": "arrears"
  },
  "metadata": {},
  "minimum_spend": {
    "amount": "500.00",
    "period": "monthly",
    "billing_direction": "arrears"
  },
  "name": "Acme Corp - Enterprise",
  "price_escalation": {
    "enabled": true,
    "interval_months": 12,
    "type": "percentage",
    "escalate_metered_unit_rates": false,
    "percentage": "5.00"
  },
  "renewal": {
    "auto_renew": true,
    "duration_months": 12,
    "period_type": "fixed"
  },
  "tags": [
    "tag_abc123"
  ],
  "trial_period_days": 30
}
'

import requests

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

payload = {
    "billing": {
        "auto_issue_invoices": True,
        "auto_pay_invoices": False,
        "autopay_timing": "on_due_date",
        "clear_autopay_timing": True,
        "first_billing_date": "2026-07-01",
        "payment_collection_method": "autopay",
        "payment_method_id": "pm_01H1VECT",
        "payment_terms": "net_30"
    },
    "description": "Annual enterprise subscription",
    "discount": {
        "amount": "10",
        "duration_type": "fixed",
        "type": "percentage",
        "duration_unit": "months",
        "duration_value": 6
    },
    "maximum_spend": {
        "amount": "500.00",
        "period": "monthly",
        "billing_direction": "arrears"
    },
    "metadata": {},
    "minimum_spend": {
        "amount": "500.00",
        "period": "monthly",
        "billing_direction": "arrears"
    },
    "name": "Acme Corp - Enterprise",
    "price_escalation": {
        "enabled": True,
        "interval_months": 12,
        "type": "percentage",
        "escalate_metered_unit_rates": False,
        "percentage": "5.00"
    },
    "renewal": {
        "auto_renew": True,
        "duration_months": 12,
        "period_type": "fixed"
    },
    "tags": ["tag_abc123"],
    "trial_period_days": 30
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    billing: {
      auto_issue_invoices: true,
      auto_pay_invoices: false,
      autopay_timing: 'on_due_date',
      clear_autopay_timing: true,
      first_billing_date: '2026-07-01',
      payment_collection_method: 'autopay',
      payment_method_id: 'pm_01H1VECT',
      payment_terms: 'net_30'
    },
    description: 'Annual enterprise subscription',
    discount: {
      amount: '10',
      duration_type: 'fixed',
      type: 'percentage',
      duration_unit: 'months',
      duration_value: 6
    },
    maximum_spend: {amount: '500.00', period: 'monthly', billing_direction: 'arrears'},
    metadata: {},
    minimum_spend: {amount: '500.00', period: 'monthly', billing_direction: 'arrears'},
    name: 'Acme Corp - Enterprise',
    price_escalation: {
      enabled: true,
      interval_months: 12,
      type: 'percentage',
      escalate_metered_unit_rates: false,
      percentage: '5.00'
    },
    renewal: {auto_renew: true, duration_months: 12, period_type: 'fixed'},
    tags: ['tag_abc123'],
    trial_period_days: 30
  })
};

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

{
  "assignments": [
    {
      "type": "owner",
      "user_id": "usr_abc123"
    }
  ],
  "billing": {
    "auto_issue_invoices": true,
    "auto_pay_invoices": false,
    "payment_collection_method": "autopay",
    "autopay_timing": "on_due_date",
    "first_billing_date": "2026-01-01T00:00:00Z",
    "payment_method_id": "pm_01H1VECT",
    "payment_terms": "net_30"
  },
  "contract": {
    "period_type": "fixed",
    "duration_months": 12,
    "end_date": "2027-01-01T00:00:00Z",
    "start_date": "2026-01-01T00:00:00Z"
  },
  "created_at": "2025-12-15T10:30:00Z",
  "currency": "USD",
  "customer_id": "cust_abc123",
  "id": "sub_abc123",
  "metadata": {},
  "name": "Acme Corp - Enterprise",
  "pending_changes": [
    {
      "status": "draft",
      "version_id": "subv_abc123",
      "description": "Q3 upgrade",
      "effective_at": "2027-01-01T00:00:00Z"
    }
  ],
  "renewal": {
    "auto_renew": true,
    "duration_months": 12,
    "period_type": "fixed"
  },
  "status": "active",
  "updated_at": "2026-04-04T10:00:05Z",
  "activated_at": "2026-01-01T00:00:00Z",
  "current_version_id": "subv_abc123",
  "discount": {
    "amount": "10",
    "duration_type": "fixed",
    "type": "percentage",
    "duration_unit": "months",
    "duration_value": 6
  },
  "maximum_spend": {
    "amount": "500.00",
    "period": "monthly",
    "billing_direction": "arrears"
  },
  "minimum_spend": {
    "amount": "500.00",
    "period": "monthly",
    "billing_direction": "arrears"
  },
  "plan_id": "pln_abc123",
  "price_escalation": {
    "enabled": true,
    "interval_months": 12,
    "type": "percentage",
    "escalate_metered_unit_rates": false,
    "percentage": "5.00"
  },
  "trial_period_days": 30
}

{
  "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

Body

application/json

billing

object | null

Billing configuration

Show child attributes

description

string | null

Description

Example:

"Annual enterprise subscription"

discount

object | null

Subscription-level discount (percentage only)

Show child attributes

maximum_spend

object | null

Maximum spend threshold

Show child attributes

metadata

object | null

Key-value metadata (null value removes key)

minimum_spend

object | null

Minimum spend threshold

Show child attributes

name

string | null

Subscription name

Example:

"Acme Corp - Enterprise"

price_escalation

object | null

Price escalation config

Show child attributes

renewal

object | null

Renewal configuration

Show child attributes

Response

Success

assignments

object[]

required

Users assigned to the subscription, such as its owner

Show child attributes

billing

object

required

Billing configuration

Show child attributes

contract

object

required

Contract configuration

Show child attributes

created_at

string<date-time>

required

When the subscription was created

Example:

"2025-12-15T10:30:00Z"

currency

string

required

ISO 4217 currency code

Example:

"USD"

customer_id

string

required

Customer ID

Example:

"cust_abc123"

string

required

Unique identifier

Example:

"sub_abc123"

metadata

object

required

Key-value metadata

name

string

required

Subscription name

Example:

"Acme Corp - Enterprise"

pending_changes

object[]

required

Pending version changes

Show child attributes

renewal

object

required

Renewal configuration

Show child attributes

status

enum<string>

required

Subscription status

Available options:

draft,

active,

canceled,

approved

Example:

"active"

updated_at

string<date-time>

required

When the subscription was last updated

Example:

"2026-04-04T10:00:05Z"

activated_at

string<date-time> | null

When the subscription was activated

Example:

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

current_version_id

string | null

Current active version ID

Example:

"subv_abc123"

discount

object | null

Subscription-level discount

Show child attributes

maximum_spend

object | null

Maximum spend threshold

Show child attributes

minimum_spend

object | null

Minimum spend threshold

Show child attributes

plan_id

string | null

Plan ID

Example:

"pln_abc123"

price_escalation

object | null

Price escalation configuration

Show child attributes

trial_period_days

integer<int64> | null

Trial period in days

Example:

30

⌘I

Update a subscription

curl --request PATCH \
  --url https://api.alguna.io/subscriptions/{id} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing": {
    "auto_issue_invoices": true,
    "auto_pay_invoices": false,
    "autopay_timing": "on_due_date",
    "clear_autopay_timing": true,
    "first_billing_date": "2026-07-01",
    "payment_collection_method": "autopay",
    "payment_method_id": "pm_01H1VECT",
    "payment_terms": "net_30"
  },
  "description": "Annual enterprise subscription",
  "discount": {
    "amount": "10",
    "duration_type": "fixed",
    "type": "percentage",
    "duration_unit": "months",
    "duration_value": 6
  },
  "maximum_spend": {
    "amount": "500.00",
    "period": "monthly",
    "billing_direction": "arrears"
  },
  "metadata": {},
  "minimum_spend": {
    "amount": "500.00",
    "period": "monthly",
    "billing_direction": "arrears"
  },
  "name": "Acme Corp - Enterprise",
  "price_escalation": {
    "enabled": true,
    "interval_months": 12,
    "type": "percentage",
    "escalate_metered_unit_rates": false,
    "percentage": "5.00"
  },
  "renewal": {
    "auto_renew": true,
    "duration_months": 12,
    "period_type": "fixed"
  },
  "tags": [
    "tag_abc123"
  ],
  "trial_period_days": 30
}
'

import requests

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

payload = {
    "billing": {
        "auto_issue_invoices": True,
        "auto_pay_invoices": False,
        "autopay_timing": "on_due_date",
        "clear_autopay_timing": True,
        "first_billing_date": "2026-07-01",
        "payment_collection_method": "autopay",
        "payment_method_id": "pm_01H1VECT",
        "payment_terms": "net_30"
    },
    "description": "Annual enterprise subscription",
    "discount": {
        "amount": "10",
        "duration_type": "fixed",
        "type": "percentage",
        "duration_unit": "months",
        "duration_value": 6
    },
    "maximum_spend": {
        "amount": "500.00",
        "period": "monthly",
        "billing_direction": "arrears"
    },
    "metadata": {},
    "minimum_spend": {
        "amount": "500.00",
        "period": "monthly",
        "billing_direction": "arrears"
    },
    "name": "Acme Corp - Enterprise",
    "price_escalation": {
        "enabled": True,
        "interval_months": 12,
        "type": "percentage",
        "escalate_metered_unit_rates": False,
        "percentage": "5.00"
    },
    "renewal": {
        "auto_renew": True,
        "duration_months": 12,
        "period_type": "fixed"
    },
    "tags": ["tag_abc123"],
    "trial_period_days": 30
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    billing: {
      auto_issue_invoices: true,
      auto_pay_invoices: false,
      autopay_timing: 'on_due_date',
      clear_autopay_timing: true,
      first_billing_date: '2026-07-01',
      payment_collection_method: 'autopay',
      payment_method_id: 'pm_01H1VECT',
      payment_terms: 'net_30'
    },
    description: 'Annual enterprise subscription',
    discount: {
      amount: '10',
      duration_type: 'fixed',
      type: 'percentage',
      duration_unit: 'months',
      duration_value: 6
    },
    maximum_spend: {amount: '500.00', period: 'monthly', billing_direction: 'arrears'},
    metadata: {},
    minimum_spend: {amount: '500.00', period: 'monthly', billing_direction: 'arrears'},
    name: 'Acme Corp - Enterprise',
    price_escalation: {
      enabled: true,
      interval_months: 12,
      type: 'percentage',
      escalate_metered_unit_rates: false,
      percentage: '5.00'
    },
    renewal: {auto_renew: true, duration_months: 12, period_type: 'fixed'},
    tags: ['tag_abc123'],
    trial_period_days: 30
  })
};

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

{
  "assignments": [
    {
      "type": "owner",
      "user_id": "usr_abc123"
    }
  ],
  "billing": {
    "auto_issue_invoices": true,
    "auto_pay_invoices": false,
    "payment_collection_method": "autopay",
    "autopay_timing": "on_due_date",
    "first_billing_date": "2026-01-01T00:00:00Z",
    "payment_method_id": "pm_01H1VECT",
    "payment_terms": "net_30"
  },
  "contract": {
    "period_type": "fixed",
    "duration_months": 12,
    "end_date": "2027-01-01T00:00:00Z",
    "start_date": "2026-01-01T00:00:00Z"
  },
  "created_at": "2025-12-15T10:30:00Z",
  "currency": "USD",
  "customer_id": "cust_abc123",
  "id": "sub_abc123",
  "metadata": {},
  "name": "Acme Corp - Enterprise",
  "pending_changes": [
    {
      "status": "draft",
      "version_id": "subv_abc123",
      "description": "Q3 upgrade",
      "effective_at": "2027-01-01T00:00:00Z"
    }
  ],
  "renewal": {
    "auto_renew": true,
    "duration_months": 12,
    "period_type": "fixed"
  },
  "status": "active",
  "updated_at": "2026-04-04T10:00:05Z",
  "activated_at": "2026-01-01T00:00:00Z",
  "current_version_id": "subv_abc123",
  "discount": {
    "amount": "10",
    "duration_type": "fixed",
    "type": "percentage",
    "duration_unit": "months",
    "duration_value": 6
  },
  "maximum_spend": {
    "amount": "500.00",
    "period": "monthly",
    "billing_direction": "arrears"
  },
  "minimum_spend": {
    "amount": "500.00",
    "period": "monthly",
    "billing_direction": "arrears"
  },
  "plan_id": "pln_abc123",
  "price_escalation": {
    "enabled": true,
    "interval_months": 12,
    "type": "percentage",
    "escalate_metered_unit_rates": false,
    "percentage": "5.00"
  },
  "trial_period_days": 30
}

{
  "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

Update a subscription

Authorizations

Headers

Path Parameters

Body

Response