Browse the API reference

Cancel Organization Subscription

post/v1/billing/subscriptions/{org_id}/subscription/{subscription_id}/cancel

Part of Billing.

Cancels a subscription. Default behavior cancels at period end (subscription stays active through the current cycle). Pass immediate=true with confirm=<resource_id> to terminate now and trigger fast-path deprovisioning of the underlying resource. Requires org owner role.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
org_idrequiredstringOrg Id
subscription_idrequiredstringSubscription Id

Request body

Optional, application/json.

FieldTypeDescription
immediateoptionalboolean

If true, cancel immediately and trigger fast-path deprovisioning of the underlying resource (within ~10 minutes). If false (default), cancel at the end of the current billing period.

Default: false

confirmoptionalstring

Required when immediate=True. Must equal the subscription's resource_id (e.g. graph_id) to confirm intent.

user_idoptionalstring

Organization member whose subscription to cancel. Defaults to the caller; canceling another member's requires org owner or admin.

Example request

curl
curl -X POST "https://api.robosystems.ai/v1/billing/subscriptions/{org_id}/subscription/{subscription_id}/cancel" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "immediate": false,
  "confirm": "string",
  "user_id": "string"
}'

Responses

200 Successful Response

FieldTypeDescription
idrequiredstring

Subscription ID

resource_typerequiredstring

Resource type (graph or repository)

resource_idrequiredstring

Resource identifier

user_idoptionalstring

Organization member the subscription belongs to. Set for repository subscriptions, which are billed to the org but granted per user.

plan_namerequiredstring

Current plan name

plan_display_namerequiredstring

Human-readable plan name for UI display

billing_intervalrequiredstring

Billing interval

statusrequiredstring

Subscription status

base_price_centsrequiredinteger

Base price in cents

current_period_startoptionalstring

Current billing period start

current_period_endoptionalstring

Current billing period end

started_atoptionalstring

Subscription start date

canceled_atoptionalstring

Cancellation date

ends_atoptionalstring

Subscription end date (when access will be revoked, especially relevant for cancelled subscriptions)

created_atrequiredstring

Creation timestamp

operation_idoptionalstring

Operation ID for tracking async tier changes via SSE

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error