Update subscription

PUT/revenue/subscriptions/{id}

Updates a subscription's status, linked price book, seat count, or date range. Use to apply mid-term changes such as upsells, downgrades, or pauses.

Request

Path parameters

Name	Type	Required	Description
id	integer	Yes	The numeric ID of the subscription to update.

Request body

Content type application/json (required).

Field	Type	Required	Description
name	string	Yes	Max length: 255
status	string	No	One of: "trial", "active", "paused", "cancelled", "expired" · Default: "active"
contract_id	integer	No
price_book_id	integer	No
customer_id	integer	No
start_date	string (date)	No
end_date	string (date), nullable	No
monthly_value	number (float)	No
currency	string	No	Default: "USD" · Max length: 3
seats	integer	No

Example

{
  "status": "paused",
  "seats": 35
}

Responses

200 Subscription updated

404 Subscription not found

Example request

curl -X PUT "https://{tenant}.faciotech.net/api/v1/revenue/subscriptions/{id}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"status": "paused", "seats": 35}'