Skip to main content
Imports multiple subscriptions in a single bulk operation. Supports free, paid, and custom plans — including feature and credit entitlements for custom plans.

Mutation

mutation ImportSubscriptionsBulk($input: ImportSubscriptionsBulkInput!) {
  importSubscriptionsBulk(input: $input)
}
The mutation returns a task ID. The import runs asynchronously — subscriptions are created in the background. Individual subscriptions that fail validation are skipped without blocking the rest of the batch.

Parameters

input
ImportSubscriptionsBulkInput
required
Input for bulk subscription import

Return Type

Returns a String — the task ID for the asynchronous import operation.

Examples

Free plan subscription

{
  "input": {
    "subscriptions": [
      {
        "customerId": "customer-123",
        "planId": "plan-free"
      }
    ]
  }
}

Custom plan with feature and credit entitlements

Custom plans use the entitlements field to define per-customer access — this can include feature entitlements (usage limits) and credit entitlements (credit allowances).
{
  "input": {
    "subscriptions": [
      {
        "customerId": "customer-456",
        "planId": "plan-enterprise-custom",
        "startDate": "2024-01-01T00:00:00Z",
        "entitlements": [
          {
            "feature": {
              "featureId": "feature-seats",
              "usageLimit": 50
            }
          },
          {
            "feature": {
              "featureId": "feature-sso",
              "hasUnlimitedUsage": true
            }
          },
          {
            "credit": {
              "customCurrencyId": "currency-api-credits",
              "amount": 100000,
              "cadence": "MONTH"
            }
          }
        ],
        "addons": [
          { "addonId": "addon-premium-support", "quantity": 1 }
        ]
      }
    ]
  }
}

Common Use Cases

Import existing subscriptions during migration to Stigg. Use startDate for backdating and billingId to link to the existing billing provider subscription.
Import custom plan subscriptions with per-customer entitlements — different seat limits, project counts, and credit allocations for each customer.
Quickly populate a staging or testing environment with subscriptions for QA.