Skip to main content
DELETE
/
payments
/
subscriptions
/
{id}
Cancel Subscription
curl --request DELETE \
  --url https://api.rootfi.dev/v4/payments/subscriptions/{id} \
  --header 'api_key: <api-key>'
{
  "success": true
}
Cancel a subscription. The subscription will stop generating new invoices and will not renew.

​
Path Parameters

ParameterTypeRequiredDescription
idstringYesThe rootfi_id or platform_id of the subscription

​
Query Parameters

ParameterTypeRequiredDescription
cancel_at_period_endbooleanNoIf true, cancels at end of current period (default: true)
proratebooleanNoIf true, issues prorated credit for unused time

​
Behavior

  • Immediate cancellation: Subscription ends immediately, may generate prorated credit
  • End of period: Subscription remains active until current billing period ends
Cancelling a subscription does not automatically refund previous payments. Use the Transactions API to process refunds if needed.

Authorizations

​
api_key
string
header
required

Path Parameters

​
id
string
required

Query Parameters

​
cancel_at_period_end
boolean

If true, cancels at end of current period

​
prorate
boolean

If true, issues prorated credit for unused time

Response

Subscription canceled successfully

​
success
boolean