POST /v1/customer-portal/subscriptions/{subscription_id}:cancel
CheckoutService_CancelCustomerPortalSubscription
The server validates credentials, tenant, environment and permissions. This page does not send requests. Replace example values; deployed server validation remains authoritative.
Parameters
subscription_idpath · string · required
Request body
subscription_idstring
cURL
curl --request POST 'https://nexus-api.rainlib.com/v1/customer-portal/subscriptions/{subscription_id}:cancel' \
--header 'Authorization: Bearer <NEXUS_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{}'Response contract
200 · OK
cancel_at_period_endbooleancurrent_period_endstringcurrent_period_startstringcustomer_account_idstringgrace_ends_atstringidstringoffer_idstringpayment_providerstringprovider_subscription_idstringrenewal_strategystringstatusstringversionstring
Generated responses do not enumerate every runtime error. See the integration guide for authentication, conflicts and retries.