​
The GraphQL endpoint

The GraphQL API has a single endpoint:

https://api.stigg.io/graphql

The endpoint remains constant no matter what operation you perform.

​
Retrieving the server API Key

In the Stigg app, go to Settings > Account > Environments.

Copy the Server API key of the relevant environment.

​
Discovering the GraphQL API

​
GraphQL explorer

You can run queries on real Stigg data using our GraphQL Explorer, an integrated development environment in your browser that includes docs, syntax highlighting, and validation errors.

To authenticate you need to pass the Server API key in the X-API-KEY request header.

Stigg API’s Graph | GraphOS Studio

​
GraphQL introspection

GraphQL is introspective. This means you can query a GraphQL schema for details about itself. You can run an introspection query by passing your Server API key as a query parameter:

https://api.stigg.io/graphql?apiKey=YOUR_SERVER_API_KEY

For example, running the following curl, will get all the available root types:

curl --request POST  
     --header 'content-type: application/json'  
     --url "https://api.stigg.io/graphql?apiKey={YOUR_SERVER_API_KEY}"  
     --data '{"query":"query { \_\_schema { types { name } } }"}'

​
Provisioning customers

When a new customer is provisioned within your application (for example: as part of your registration or onboarding process), you should also provision them in Stigg.

The customer’s billing information can also be passed to Stigg when a customer is created or updated. When Stigg is integrated with additional service, this information will be propagated to the active integrations. The billing information is not persisted on Stigg’s servers.

You can optionally pass subscriptionParams to create subscription for that customer using a single operation. Doing so, will allow Stigg admins to override the requested subscription with no-code from the Stigg Console using the product’s Customer Journey configuration.

Query

mutation ProvisionCustomer($input: ProvisionCustomerInput!) {  
  provisionCustomer(input: $input) {  
    customer {
      refId  
      name 				# optional 
      email				# optional - billing email address
      createdAt  
      billingId  
      crmId  
      hasPaymentMethod  
      additionalMetaData # optional
    }
    subscriptionDecisionStrategy
    subscription {
      refId
      status
      plan {
        refId
      }
    }
  }  
}

Variables

{  
  "input": {  
    "refId": "customer-id",  
    "name": "Acme",  
    "email": "john@example.com",  
    "couponRefId": "coupon-id",  
    "billingInformation": {  
      "language": "en",  
      "timezone": "America/New_York",  
      "billingAddress": {  
        "country": "US",  
        "city": "New York",  
        "state": "NY",  
        "addressLine1": "123 Main Street",  
        "addressLine2": "Apt. 1",  
        "phoneNumber": "+1 212-499-5321",  
        "postalCode": "10164"  
      },  
      "shippingAddress": {  
        "country": "US", // country format must be in the ISO-3166-1 format
        "city": "New York",  
        "state": "NY",  
        "addressLine1": "123 Main Street",  
        "addressLine2": "Apt. 1",  
        "phoneNumber": "+1 212-499-5321",  
        "postalCode": "10164"  
      }  
    },  
    "additionalMetaData": {  
      "key": "value"  
    },
    "subscriptionParams": {
      "planId": "plan-revvenu-basic",
    }
  },
}

​
Updating customers

Customer information can also be updated whenever you like assuming it already exists, for example: In order to update the customer’s email, you only need to send the new email value without the rest of the customer. Due to the fact that the customer’s billing information is not persisted on Stigg’s servers, in order to update it, the entire billing information object must be passed each time.

Query

mutation UpdateOneCustomer($input: UpdateCustomerInput!) {  
  updateOneCustomer(input: $input) {  
    refId  
    name  
    email  
    createdAt  
    billingId  
    crmId  
    hasPaymentMethod  
    additionalMetaData  
  }  
}

Variables

{
  "input": {
    "email": "john@example.com",
    "name": "Acme",
    "refId": "customer-id",
    "billingInformation": {
      "language": "en",
      "timezone": "America/New_York",
      "currency":"USD",
      "taxIds": [
        {"type": "...", "value": "..."}
      ],
    },
    "additionalMetaData": {
      "key": "value"
    }
  }
}

​
Getting customer data

Query

fragment CouponFragment on Coupon {
  id
  discountValue
  additionalMetaData
  refId
  name
  description
  createdAt
  updatedAt
  billingId
  type
  status
}

fragment PromotionalEntitlementFragment on PromotionalEntitlement {
  status
  usageLimit
  featureId
  hasUnlimitedUsage
  resetPeriod
  endDate
  isVisible
  feature {
    displayName
    description
    refId
  }
}

fragment CustomerFragment on Customer {
  id
  name
  email
  createdAt
  updatedAt
  hasPaymentMethod
  customerId
  billingId
  additionalMetaData
  coupon {
    ...CouponFragment
  }
  promotionalEntitlements {
    ...PromotionalEntitlementFragment
  }
}

query GetCustomerByRefId($input: GetCustomerByRefIdInput!) {
  getCustomerByRefId(input: $input) {
    ...CustomerFragment
  }
}

Variables

{
  "input": {
    "customerId": "customer-demo-01"
  }
}

​
Getting customer active subscriptions

Query

fragment SubscriptionFragment on CustomerSubscription {
  subscriptionId
  status
  pricingType
  startDate
  currentBillingPeriodEnd
  customer {
    customerId
  }
  resource {
    resourceId
  }
  plan {
    planId: refId
    displayName
  }
  addons {
    quantity
    addon {
      addonId: refId
    }
  }
}

query GetActiveSubscriptionsList($input: GetActiveSubscriptionsInput!) {
  getActiveSubscriptions(input: $input) {
    ...SubscriptionFragment
  }
}

Variables

{
  "input": {
    "customerId": "customer-demo-01",
    "resourceId": "resource-01",  // optional, pass it to get subscription of specific resource
  }
}

​
Getting a subscription

Query

fragment PriceFragment on Price {
  billingModel
  billingPeriod
  price {
    amount
    currency
  }
  feature {
    featureUnits
    featureUnitsPlural
    displayName
    refId
  }
}

fragment TotalPriceFragment on CustomerSubscriptionTotalPrice {
  subTotal {
    amount
    currency
  }
  total {
    amount
    currency
  }
}

fragment AddonFragment on Addon {
  id
  refId
  displayName
  description
  additionalMetaData
}

fragment PlanFragment on Plan {
  id
  refId
  displayName
  description
  additionalMetaData
}

fragment SubscriptionFragment on CustomerSubscription {
  id
  startDate
  endDate
  trialEndDate
  cancellationDate
  effectiveEndDate
  status
  refId
  currentBillingPeriodEnd
  additionalMetaData
  prices {
    usageLimit
    price {
      ...PriceFragment
    }
  }
  totalPrice {
    ...TotalPriceFragment
  }
  pricingType
  plan {
    ...PlanFragment
  }
  addons {
    id
    quantity
    addon {
      ...AddonFragment
    }
  }
  paymentCollection
  latestInvoice {
    billingId
    status
    createdAt
    updatedAt
    requiresAction
    paymentUrl
    paymentSecret
    errorMessage
  }
}

query GetActiveSubscriptions($input: GetSubscriptionInput!) {
  getSubscription(input: $input) {
    ...SubscriptionFragment
  }
}

Variables

{
  "input": {
    "subscriptionId": "subscription-id",
  }
}

​
Provisioning subscriptions

When a customer subscribes to a new plan (free, paid, trial, etc.), provision the subscription in Stigg.

Query

mutation CreateSubscription($input: ProvisionSubscriptionInput!) {  
  provisionSubscription: provisionSubscriptionV2(subscription: $input) {  
    id  
    refId  
    status  
    additionalMetaData  
    plan {  
      id  
      refId  
    }  
    addons {  
      quantity  
      addon {  
        id  
        refId  
      }  
    }  
    customer {  
      id  
      refId  
    }
    resource {
      resourceId
    }
    paymentCollection
    latestInvoice {
      billingId
      status
      createdAt
      updatedAt
      requiresAction
      paymentUrl
      paymentSecret
      errorMessage
    }
  }  
}

Variables

{  
  "input": {  
    "customerId": "customer-id",  
    "planId": "plan-revvenu-basic",  
    "billingPeriod": "MONTHLY",  
    "billingCountryCode":"DK",   // optional - if multicurrency is enabled
    "addons": [  
      {  
        "addonId": "addon-extra-stuff",  
        "quantity": 2  
      }  
    ],  
    "additionalMetaData": {  
      "key": "value"  
    },
    "resourceId": "resource-01"   // optional, required for multiple subscription for same product
  }  
}
  1. A customer can have both a non-trial (free or paid) subscription and trial subscription to different plans of the same product in parallel - this logic allows customers to trial a higher tier plan, while still paying for an existing plan.
  2. When the customer has a trial subscription for plan X of product A and a new subscription is created for the same plan, the new subscription will be created as non-trial (paid) subscription - this logic follows an upgrade flow of a trial subscription to a paid subscription of a specific plan.
  3. Except in the above-mentioned cases, when a customer has an active subscription for product X, and another subscription for the same product is created with start date S, the existing subscription will automatically be cancelled and the new subscription will start on start date S. It’s also possible to explicitly skip the trial period of the selected plan by providing the skipTrial: true parameter to the CreateSubscription mutation.

​
Updating subscriptions

Updating an existing subscription, this can be used to update the feature quantity that the customer is subscribed for.

Query

mutation UpdateOneSubscription($input: UpdateSubscriptionInput!) {  
  updateOneSubscription(input: $input) {  
    id  
    refId  
    status  
    additionalMetaData  
    plan {  
      id  
      refId  
    }  
    addons {  
      quantity  
      addon {  
        id  
        refId  
      }  
    }  
    customer {  
      id  
      refId  
    }
    paymentCollection
    latestInvoice {
      billingId
      status
      createdAt
      updatedAt
      requiresAction
      paymentUrl
      paymentSecret
      errorMessage
    }
  }  
}

Variables

{
  "input": {
    "refId": "subscription-plan-professional-4dfecf",
    "billableFeatures": [{
      "featureId": "feature-01-templates",
      "quantity": 2
    }],
  }
}

​
Cancel subscription

Query

mutation CancelSubscription($input: SubscriptionCancellationInput!) {  
  cancelSubscription(input: $input) {  
    refId  
    status  
    additionalMetaData  
  }  
}

Variables

{
  "input": {
    "subscriptionRefId": "subscription-id",
    "subscriptionCancellationTime":  "IMMEDIATE"
  }
}

Subscription cancellation will take place according to the defined product behavior.

​
Getting the entitlement of a customer for a specific feature

Used to check if the customer has access to a feature, the usage limit, and the current usage.

Query

query GetEntitlement($query: FetchEntitlementQuery!) {  
  entitlement(query: $query) {  
    isGranted  
    feature {  
      refId  
      displayName  
      featureUnits  
      featureUnitsPlural  
      featureType  
      meterType  
      description  
    }  
    currentUsage  
    customerId  
    accessDeniedReason  
    requestedUsage  
    usageLimit  
    hasUnlimitedUsage  
    usagePeriodAnchor
    usagePeriodStart
    usagePeriodEnd
    resetPeriod  
  }  
}

Variables

{  
  "query": {  
    "customerId": "customer-id",  
    "featureId": "feature-01-templates",  
    "options": {  
      "requestedUsage": 0  
    },
    "resourceId": "resource-01",       // optional, pass it to get entitlement of specific resource
  }  
}

​
Getting all of the entitlements of a customer

Used to check to what features the customer has access to, the usage limit , and the current usage of each entitlement.

Query

query GetEntitlements($query: FetchEntitlementsQuery!) {
  cachedEntitlements(query: $query) {
    feature {
      refId
      displayName
      featureUnits
      featureUnitsPlural
      featureType
      meterType
      description
    }
    currentUsage
    customerId
    usageLimit
    hasUnlimitedUsage
    usagePeriodAnchor
    usagePeriodStart
    usagePeriodEnd
    resetPeriod
  }
}

Variables

{
  "query": {
    "customerId": "customer-id",
    "resourceId": "resource-01",    // optional, pass it to get entitlements of specific resource
  }
}

​
Reporting usage measurements to Stigg

The Stigg API allows you to report usage measurements for metered features. The reported usage will be used to track, limit and bill the customer’s usage of metered features.

Stigg supports metering of usage from the following data sources:

  1. Calculated usage - usage that has been aggregated and calculated by your application. This type is useful for features, such as: seats.
  2. Raw events - raw events from your application, which Stigg filters and aggregates aggregate to calculate customer usage. This type is useful for features, such as: monthly active users (MAUs).

More details about Stigg’s metering and aggregation capabilities can be found here:

Stigg's metering and aggregation capabilities
  1. Reporting of measurements to Stigg should be done only after the relevant resources have been provisioned in your application.
  2. To ensure that the provisioned resources are aligned with the measurements that are reported to Stigg, ensure that customers are not allowed to allocate new resources until an acknowledgement about the processed measurement is received from the Stigg backend.

Validating that a measurement was successfully reported to Stigg is also possible in the customer details section of the relevant customer in the Stigg app.

​
Calculated usage

#Query

mutation ReportUsage($input: ReportUsageInput!) {  
  reportUsage(input: $input) {  
    id  
  }  
}

#Variables

{  
  "input": {  
    "value": 5,  
    "customerId": "customer-id",  
    "featureId": "feature-02-campaigns",
    "resourceId": "resource-01",       // optional, pass it to report usage for specific resource
  }  
}

​
Raw events

#Query

mutation ReportEvent($events: UsageEventsReportInput!) {
  reportEvent(events: $events)
}

#Variables

{
  "events": {
    "usageEvents": [
      {
        "customerId": "customer-demo-01",
        "dimensions": {"user_id": "a_user_id"},
        "eventName": "user_login",
        "idempotencyKey": "888888888"
      }
    ]
  }
}

It’s also possible to send a batch of events in one invocation. To do so, simply pass an array of events to the reportEvent method.

Response

The mutation has no return value

​
Getting available coupons

Query

fragment CouponFragment on Coupon {  
    id  
    discountValue  
    type  
    additionalMetaData  
    refId  
    name  
    description  
    createdAt  
    updatedAt  
    billingId  
    type  
    status  
}

query FetchCoupons($filter: CouponFilter) {  
    coupons(filter: $filter, sorting: $sorting, paging: $paging) {  
      edges {  
        node {  
          ...CouponFragment  
        }  
      }  
    }  
}

Variables

{  
  "filter": {  
    "status": {  
      "eq": "ACTIVE",  
    },  
  },  
}

​
Estimate subscription cost

You can estimate the subscription cost using the estimateSubscription method. This can help the customer to understand the costs before paying.

Query

mutation EstimateSubscription($input: EstimateSubscriptionInput!) {
  estimateSubscription(input: $input) {
    subTotal {
      amount
      currency
    }
    total {
      amount
      currency
    }
    billingPeriodRange {
      start
      end
    }
    proration {
      prorationDate
      credit {
        amount
        currency
      }
      debit {
        amount
        currency
      }
    }
  }
}

Variables

{
  "input": {
    "customerId": "customer-demo-01",
    "billingPeriod": "MONTHLY",
    "planId": "plan-revvenu-essentials",
    "billableFeatures": [{
      "featureId": "feature-01-templates",
      "quantity": 2
    }],
    "addons": [
      {
        "addonId": "addon-10-campaigns",
        "quantity": 2
      }
    ],
    "startDate": null,
    "billingInformation": {
      "taxRateIds": null
    }
  }
}

You can also estimate the cost of updating an existing subscription using the updateSubscription method, which also returns a breakdown of the proration amounts:

Query

mutation EstimateSubscriptionUpdate($input: EstimateSubscriptionUpdateInput!) {
  estimateSubscriptionUpdate(input: $input) {
    subTotal {
      amount
      currency
    }
    total {
      amount
      currency
    }
    billingPeriodRange {
      start
      end
    }
    proration {
      prorationDate
      credit {
        amount
        currency
      }
      debit {
        amount
        currency
      }
    }
  }
}

Variables

{
  "input": {
    "subscriptionId": "subscription-plan-revvenu-growth-da6324",
    "billableFeatures": [{
      "featureId": "feature-01-templates",
      "quantity": 7
    }],
    "addons": [
      {"addonId": "addon-10-campaigns", "quantity": 2 }
    ]
  }
}

​
Migrating subscriptions to the latest plan and add-on version

When changes to plans and add-ons are rolled out only to new subscriptions, grandfathering takes place. In order to prevent a SKU sprawl, Stigg allows you to manually migrate subscriptions to the latest plan and add-on version on a subscription-by-subscription basis.

When the current price of the subscription is different than the latest published package version, during the migration the customer will be charged or credited the prorated amount until the end of the current billing period depending on whether the latest price is more expensive or cheaper than the current subscription price.

Query

mutation MigrateSubscriptionToLatest($input: SubscriptionMigrationInput!) {
  migrateSubscriptionToLatest(input: $input) {
    subscriptionId
  }
}

Variables

{
  "input": {
    "subscriptionId": "subscription-plan-revvenu-basic-6fb76d",
    "subscriptionMigrationTime":"END_OF_BILLING_PERIOD"
  }
}

​
Archiving & unarchiving customers

When a customer is archived:

  1. Its PII (name and email address) will be nullified.
  2. It will no longer appear in the Stigg app UI.
  3. It will no longer be returned by the Stigg API and SDKs.

When Stigg is integrated with a billing solution, customers that are archived in Stigg will still exist in the billing solution to allow upcoming invoices to be finalized. Archiving customers in the billing solution can be done manually in the billing solution.

To archive a customer:

await stiggClient.archiveCustomer("customer-a18f01")

To unarchive a customer:

await stiggClient.unarchiveCustomer("customer-a18f01")

​
Full API reference

Stigg GraphQL API reference

Stigg API’s Graph | GraphOS Studio