licenses

Cancel Subscription

Cancel a license's Paddle subscription, effective at the next billing period (admin-only, behind ica-self-payments-v1 OR ica-self-payments-v2 -- reused, not a new flag; see the design doc's "Cancel endpoint" flag note, D-2121-COORD-14/D-2121-29, for why: production has no real subscriptions yet, and the render condition on paddle_subscription means the button can't appear for anyone until a real subscription exists regardless of the flag, so a dedicated flag was buying no safety at the cost of a third flag in an epic already carrying flag-removal debt). 404s when the license has no Paddle subscription at all (nothing to cancel), never 403 on a cross-tenant license id.

Inline flag gate (not Depends(require_feature_enabled(...)), unlike reset/assign-grid above): the admin check above must be independently visible at the route, not inferred from the flag helper also happening to require it (D-2121-USER-5) -- mirrors billing/router.py's inline resolve_flag + raise_404_if_disabled shape (_self_payments_enabled uses get_all_flags directly to check both flags in one PostHog round-trip), paired here with the explicit admin dependency.

post/licenses/{license_public_id}/cancel-subscription

Request

  • Base URL: https://api.incredibuild.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.incredibuild.com/licenses/{license_public_id}/cancel-subscription
  • Auth: HTTP bearer

Path parameters

license_public_idstring uuid required

Headers

x-public-tenant-idstring uuid nullable
x-public-user-idstring uuid nullable

Response

Successful Response

public_idstring uuid required
license_keystring required
namestring nullable
expires_atstring date-time nullable required
tier_namestring nullable required
addon_featuresstring[] required
fixed_initiatorsinteger required
floating_initiatorsinteger required
fixed_ci_initiatorsinteger required
floating_ci_initiatorsinteger required
fixed_helper_coresinteger required
floating_helper_coresinteger required
cache_coresinteger required
platform'windows' | 'linux' required
grid_public_idstring uuid nullable required
grid_namestring nullable required
allow_offlineboolean
offline_reset_atstring date-time nullable
offline_reset_countinteger
is_activeboolean
licensespring_customer_idstring nullable
licensespring_customer_namestring nullable
source'salesforce' | 'licensespring' | 'manual'
is_trialboolean
has_license_rowboolean
pending_changesobject nullable
attention_state'expired_paid' | 'payment_issue_active' | 'payment_issue_access_ended' nullable

Changes

No recorded changes to this operation across all 1 revision of this API.