Renew a Subscription

🚧

Limited Availability

Access to the Compliance API is currently limited to approved partners. Endpoints, request/response shapes, and field names may change before reaching general availability — use against staging for early integration work and coordinate with your CorpNet account manager before relying on Compliance API calls in production-critical paths. Report issues or feedback to your account manager.

POST /v1/partners/{partnerId}/subscriptions/{subscriptionId}/renew

Updates renewal-related fields on a subscription plan — start/end dates, renewal date, renewal type, and auto-renew flag. Use this to extend an active subscription, switch a manual subscription to auto-renewal, or correct renewal dates.

Path Parameters

Request Body

{
  "id": "a0S5e000001ABCD",
  "entityId": "a0A5e000002abcd",
  "serviceState": "CA",
  "startDate": "2026-01-01",
  "endDate": "2026-12-31",
  "renewalDate": "2026-12-01",
  "renewalType": "Auto Renewal",
  "serviceType": "AnnualReport",
  "autoRenew": true
}

Request Body Fields

Example

curl -s -X POST \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"a0S5e000001ABCD","renewalType":"Auto Renewal","renewalDate":"2026-12-01"}' \
  "https://api.corpnet.com/v1/partners/P123456/subscriptions/a0S5e000001ABCD/renew"

Response — 200 OK

{ "data": true }

A boolean true confirms the renewal update was applied. To verify the new state, re-fetch via Get a Subscription.

Error Responses

{ "statusCode": 400, "message": "No matching record found for Id: a0SXXXXXXXXXX", "data": false }
{ "statusCode": 403, "message": "You don't have access to this order information", "data": false }