Skip to main content

cancelSharedSubscription

DESTRUCTIVE. Cancels an app's paid shared-environment subscription. The app loses its paid shared slot (typically at currentPeriodEnd) and may be denied runtime once the period lapses unless a free slot covers it. Returns the updated subscription. Requires the 'manage_billing' permission on the app's org.

cancelSharedSubscription(
  appId: BigInt!
  idempotencyKey: String
): AppSharedSubscription!

Arguments​

cancelSharedSubscription.appId ● BigInt! non-null scalar​

App id (BigInt) whose subscription to cancel.

cancelSharedSubscription.idempotencyKey ● String scalar​

Optional idempotency key. Recommended for retries: replaying with the same key and identical arguments returns the first result instead of re-applying; the same key with different arguments returns IDEMPOTENCY_CONFLICT. Keys expire after 24h.

Type​

AppSharedSubscription object​

@deprecated Legacy paid shared-environment subscription for an app slot. Null when the app has none.