Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stigg.io/llms.txt

Use this file to discover all available pages before exploring further.

Modifies an existing subscription, allowing addon updates, billing period changes, and more.
Plan changes are not supported by this mutation. To change a subscription’s plan, use provisionSubscription instead.

​
Mutation

mutation UpdateSubscription($input: UpdateSubscriptionInput!) {
  updateOneSubscription(input: $input) {
    subscriptionId
    status
    plan {
      refId
      displayName
    }
    addons {
      addon {
        refId
        displayName
      }
      quantity
    }
    prices {
      billingPeriod
      price {
        amount
        currency
      }
    }
  }
}

​
Parameters

​
input
UpdateSubscriptionInput
required
Input for updating a subscription

​
Return Type

Returns the updated CustomerSubscription object.

​
Examples

​
Add Addon

{
  "input": {
    "subscriptionId": "sub-789",
    "addons": [
      { "addonId": "addon-seats", "quantity": 5 },
      { "addonId": "addon-storage", "quantity": 1 }
    ]
  }
}

​
Change Billing Period

{
  "input": {
    "subscriptionId": "sub-789",
    "billingPeriod": "ANNUAL"
  }
}

​
Common Use Cases

Increase addon quantity for seat-based subscriptions.
Change from monthly to annual billing.