Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB
Billing: Subscriptions

Enable auto-renewal

Enable auto-renewal for a subscription.

Use this endpoint when enable auto-renewal for a subscription.

patch/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable

Path parameters

subscriptionIdstring required
Example:Cxy353Uhl1xC54pG6

Subscription ID

Response

Success response

idstring

Subscription ID

namestring
status'active' | 'paused' | 'cancelled' | 'not_renewing' | 'transferred' | 'in_trial' | 'future'
billing_periodinteger
billing_period_unitstring
currency_codestring
total_priceinteger

Total price in cents

renewal_priceinteger

Renewal price in cents

is_auto_renewedboolean
created_atstring date-time
expires_atstring date-time nullable
next_billing_atstring date-time nullable

Example response

{
  "id": "Azz36nUfKX1S1MSF",
  "name": "KVM 1",
  "status": "active",
  "billing_period": 1,
  "billing_period_unit": "day",
  "currency_code": "USD",
  "total_price": 1799,
  "renewal_price": 1799,
  "is_auto_renewed": true,
  "created_at": "2025-02-27T11:54:22Z",
  "expires_at": "2025-03-27T11:54:22Z",
  "next_billing_at": "2025-02-28T11:54:22Z"
}