​
Overview

This library provides a Java client to interact with Stigg’s GraphQL API based on API operations that are in use by the Stigg’s Node.js SDK

By leveraging Apollo Kotlin to generate Java classes for GraphQL types, and okhttp as default HTTP client responses are being automatically converted to native Java classes.

​
Installing the SDK

The first step is to add the SDK as a dependency in your Java application :


dependencies {
  implementation 'io.stigg:stigg-api-client:+'
  implementation 'com.apollographql.apollo3:apollo-runtime:3.8.2'
  implementation 'com.apollographql.apollo3:apollo-api-jvm:3.8.2'
  implementation 'com.apollographql.apollo3:apollo-adapters-jvm:3.8.2'
}

repositories {
  mavenCentral()
}

It’s recommended to hard code the stigg-api-client version according to the latest version available here

​
Retrieving the server API Key

In the Stigg Cloud Console, go to Settings > Account > Environments.

Copy the Server API key of the relevant environment.

​
Initializing the SDK

Import the Stigg client and initialize it with the API key.

Synchronous client:

import io.stigg.api.client.Stigg;

class App {
    public static void main(String[] ...args) {
        var stigg = Stigg.createClient("<SERVER-API-KEY>");
    }
}

​
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.

var resp = stigg.mutation(
  ProvisionCustomerMutation.builder()
  .input(ProvisionCustomerInput.builder()
         // all fields are optional
         .customerId("customer-81726628184")
         .name("Acme")
         .email("john@example.com")
         .billingInformation(CustomerBillingInfo.builder()
                             .billingAddress(Address.builder()
                                             .country("US")
                                             .city("New York")
                                             .state("NY")
                                             .addressLine1("123 Main Street")
                                             .addressLine2("Apt. 1")
                                             .phoneNumber("+1 212-499-5321")
                                             .postalCode("10164")
                                             .build())
                             .build())
         .additionalMetaData(new HashMap<>() {{
           put("key", "value");
         }})
         .subscriptionParams(ProvisionCustomerSubscriptionInput.builder()
                             .planId("plan-revvenu-basic")
                             .build())
         .build())
  .build()
);

​
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.

var resp = stigg.mutation(
  UpdateCustomerMutation.builder()
  .input(UpdateCustomerInput.builder()
         .customerId("customer-demo-01")
         .name("Acme")
         .email("john@example.com")
         .additionalMetaData(new HashMap<>() {{
           put("key", "value");
         }})
         .billingInformation(CustomerBillingInfo.builder()
                             .language("en")
                             .timezone("America/New_York")
                             .currency(Currency.USD)
                             .taxIds(List.of(
                               TaxExempt.builder()
                               .type("vat")
                               .value("123456789")
                               .build()
                             ))
                             .build())
         .build())
  .build()
);

​
Getting customer data

var resp = stigg.query(
  GetCustomerByIdQuery.builder()
  .input(GetCustomerByRefIdInput.builder().customerId("customer-demo-01").build())
  .build()
);

​
Getting customer active subscriptions

The GetActiveSubscriptionsList method returns a list of slim subscription data, for extended data for a specific subscription use GetSubscription method.

var resp = stigg.query(
  GetActiveSubscriptionsListQuery.builder()
  .input(GetActiveSubscriptionsInput.builder()
         .customerId("customer-demo-01")
         .resourceId("site-1") // optional resource ID
         .build())
  .build()
);

​
Getting a subscription

To retrieve extended subscription:

var resp = stigg.query(
  GetSubscriptionQuery.builder()
  .input(GetSubscriptionInput.builder()
         .subscriptionId("subscription-id")
         .build())
  .build()
);

​
Provision subscriptions

When a customer subscribes to a new plan (for example: during an upgrade from a free plan to a paid plan, or downgrade from a higher tier to a lower tier), a subscription needs to be created in Stigg.

When provisioning of a paid subscription is attempted, Stigg is integrated with a billing solution and payment details have not been previously provided by the customer, Stigg will auto-magically redirect customers to a the billing solution’s checkout page. After the customer enters the required payment details in the presented checkout page, the relevant subscription will be created in both Stigg and the billing solution.

When no payment is required or when Stigg is not integrated with a billing solution, the subscription will be immediately created in Stigg.

When a customer subscribes to a new plan (free, paid, trial, etc.), provision a subscription in Stigg. The provision result can be a successfully created subscription, or a redirect link to stripe checkout in case payment is needed.

var resp = stigg.mutation(
  ProvisionSubscriptionMutation.builder()
  .input(ProvisionSubscriptionInput.builder()
         .customerId("customer-demo-01")
         .planId("plan-revvenu-basic")
         // optional, required for multiple subscription for same product:
         .resourceId("site-1")
         // optional, required for paid plans:
         .billingPeriod(BillingPeriod.MONTHLY)
         // optional, required for plans with per-unit pricing with charges:
         .billableFeatures(List.of(
           BillableFeatureInput.builder()
           .featureId("feature-01-templates")
           .quantity(2.0)
           .build()
         ))
         // optional:
         .addons(List.of(
           SubscriptionAddonInput.builder()
           .addonId("addon-extra-stuff")
           .quantity(5)
           .build()
         ))
         // optional, required for price localization, must be in the ISO-3166-1 format:
         .billingCountryCode("DK")
         // optional, but will throw if missing and no customer payment method is available:
         .checkoutOptions(
           CheckoutOptions.builder()
           .successUrl("https://your-success-url.com")
           .cancelUrl("https://your-cancel-url.com")
           .allowPromoCodes(true)
           .collectBillingAddress(true)
           .collectPhoneNumber(true)
           .build()
         )
         .additionalMetaData(new HashMap<>() {{
           put("key", "value");
         }})
         .build())
  .build()
);
  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 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.
  4. It’s also possible to explicitly skip the trial period of the selected plan by providing the skipTrial: true parameter to the provisionSubscription() method.

​
Updating subscriptions

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

var resp = stigg.mutation(
  UpdateSubscriptionMutation.builder()
  .input(
    UpdateSubscriptionInput.builder()
    .subscriptionId("subscription-plan-revvenu-essentials-bum2flivze")
    .billableFeatures(List.of(
      BillableFeatureInput.builder()
      .featureId("feature-01-templates")
      .quantity(5.0)
      .build()
    ))
    // optional:
    .addons(List.of(
      SubscriptionAddonInput.builder()
      .addonId("addon-extra-stuff")
      .quantity(5)
      .build()
    ))
    .build()
  )
  .build()
);

​
Cancel subscription

var resp =
  stigg.mutation(
    CancelSubscriptionMutation.builder()
    .input(
      SubscriptionCancellationInput.builder()
      .subscriptionRefId("subscription-plan-revvenu-essentials-bum2flivze")
      // optional:
      .subscriptionCancellationAction(SubscriptionCancellationAction.DEFAULT)
      // optional:
      .subscriptionCancellationTime(SubscriptionCancellationTime.END_OF_BILLING_PERIOD)
      .build())
    .build());

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.

var resp =
  stigg.query(
    GetEntitlementQuery.builder()
    .query(FetchEntitlementQuery.builder()
           .customerId("customer-demo-01")
           .featureId("feature-01-templates")
           .options(EntitlementOptions.builder()
                    .requestedUsage(10.0)
                    .build())
           .resourceId("site-1") // optional resource ID
           .build())
    .build()
  );

​
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.

var resp =
stigg.query(
  GetEntitlementsQuery.builder()
  .query(
    FetchEntitlementsQuery.builder()
    .customerId("customer-demo-01")
    .resourceId("site-1") // optional resource ID
    .build())
  .build());

​
Getting paywall data

Useful for rendering the public pricing page or customer paywall.

var resp = stigg.query(GetPaywallQuery.builder()
                       .input(GetPaywallInput.builder()
                              // optional, filters by product
                              .productId("product-revvenu")
                              // optional, omit if customer doesn't exist yet
                              .customerId("customer-demo-01") 
                              // optional
                              .resourceId("resource-01") 
                              // optional, for localized prices
                              .billingCountryCode("US") 
                              // optional, fetches all countries prices
                              .fetchAllCountriesPrices(false) 
                              .build())
                       .build());

​
Reporting usage measurements to Stigg

The Stigg SDK 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 Cloud Console.

​
Calculated usage

var resp =
  stigg.mutation(
    ReportUsageMutation.builder()
    .input(
      ReportUsageInput.builder()
      .customerId("customer-demo-01")
      .featureId("feature-01-templates")
      .value(1.0)
      .resourceId("site-1") // optional resource ID
      .build())
    .build());

By default, the value reported should represent the change in usage of the feature, for example user added 2 more seats then the report usage call should have the value of 2.

In some cases, it’s more useful to set the usage to some value instead of reporting the change value, it’s possible by passing the updateBehavior parameter:

var resp =
  stigg.mutation(
    ReportUsageMutation.builder()
    .input(
      ReportUsageInput.builder()
      .customerId("customer-demo-01")
      .featureId("feature-02-campaigns")
      .value(3.0)
      .updateBehavior(UsageUpdateBehavior.SET)
      .build())
    .build());

​
Raw events

var resp =
  stigg.mutation(
    ReportEventMutation.builder()
    .input(
      UsageEventsReportInput.builder()
      .usageEvents(List.of(
        UsageEventReportInput.builder()
        .customerId("customer-demo-01")
        .eventName("user_login")
        .idempotencyKey("227c1b73-883a-457b-b715-6ba5a2c69ce4")
        .timestamp(Instant.now())
        .dimensions(new HashMap<>() {{
          put("user_id", "user-01");
          put("ip", "127.0.0.1");
        }})
        .resourceId("site-1") // optional resource ID
        .build()
      ))
      .build())
    .build());

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.

​
Getting available coupons

var resp = stigg.query(GetCouponsQuery.builder().build());

​
Granting promotional entitlements

You can grant promotional entitlements for customers using the grant_promotional_entitlements method.

var resp =
  stigg.mutation(
    GrantPromotionalEntitlementsMutation.builder()
    .input(
      GrantPromotionalEntitlementsInput.builder()
      .customerId("customer-demo-01")
      .promotionalEntitlements(
        List.of(
          GrantPromotionalEntitlementInput.builder()
          .featureId("feature-04-analytics")
          .period(PromotionalEntitlementPeriod.ONE_MONTH)
          .build(),
          GrantPromotionalEntitlementInput.builder()
          .featureId("feature-02-campaigns")
          .period(PromotionalEntitlementPeriod.CUSTOM)
          .customEndDate(Instant.now().atZone(ZoneId.of("UTC")).plusDays(30).toInstant())
          .usageLimit(100.0)
          .build()
        )
      )
      .build())
    .build()
  );

​
Revoking promotional entitlements

You can revoke promotional entitlements from customer using the revoke_promotional_entitlements method.

var resp =
  stigg.mutation(
    RevokePromotionalEntitlementMutation.builder()
    .input(
      RevokePromotionalEntitlementInput.builder()
      .featureId("feature-04-analytics")
      .customerId("customer-demo-01")
      .build()
    )
    .build());

​
Estimate subscription cost

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

var resp =
  stigg.mutation(
    EstimateSubscriptionMutation.builder()
    .input(
      EstimateSubscriptionInput.builder()
      .customerId("customer-demo-01")
      .billingPeriod(BillingPeriod.MONTHLY)
      .planId("plan-revvenu-essentials")
      .billableFeatures(
        List.of(
          BillableFeatureInput.builder()
          .featureId("feature-01-templates")
          .quantity(5.0)
          .build()))
      .addons(
        List.of(
          SubscriptionAddonInput.builder()
          .addonId("addon-10-campaigns")
          .quantity(5)
          .build()))
      .billingCountryCode("DK")
      .resourceId("site-1") // optional resource ID
      .build())
    .build());

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

var resp =
  stigg.mutation(
    EstimateSubscriptionUpdateMutation.builder()
    .input(
      EstimateSubscriptionUpdateInput.builder()
      .subscriptionId("subscription-plan-revvenu-essentials-bum2flivze")
      .billableFeatures(
        List.of(
          BillableFeatureInput.builder()
          .featureId("feature-01-templates")
          .quantity(5.0)
          .build())
      )
      .addons(
        List.of(
          SubscriptionAddonInput.builder()
          .addonId("addon-10-campaigns")
          .quantity(5)
          .build())
      )
      .build())
    .build());

​
SDK changelog

Java SDK changelog