Skip to main content
Update an existing subscription. Common updates include changing the billing amount, interval, or subscription items.

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe rootfi_id or platform_id of the subscription

Request Body

FieldTypeRequiredDescription
amountnumberNoNew recurring charge amount
intervalstringNoNew billing frequency
interval_countintegerNoNew interval count
statusstringNoChange status (e.g., pause with paused)
itemsarrayNoUpdate subscription items
Changes to amount or items typically take effect on the next billing cycle. Some platforms prorate changes immediately.
See Subscription Overview for complete field details.