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.
data = await client.provision_customer(ProvisionCustomerInput(**{ "refId": "customer-demo-123", "name": "Acme", # optional "email": "john@example.com", # optional - billing email address "couponRefId": "coupon-id", # optional "subscriptionParams": { "planId": "plan-revvenu-basic", "billingCountryCode": "DK" # optional, required for price localization, must be in the ISO-3166-1 format }, "billingInformation": { # optional "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", "city": "New York", "state": "NY", "addressLine1": "123 Main Street", "addressLine2": "Apt. 1", "phoneNumber": "+1 212-499-5321", "postalCode": "10164" } }, "additionalMetaData": { # optional "key": "value" } }))
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.
The get_active_subscriptions_list method returns a list of slim subscription data, for extended data for a specific subscription use get_subscription method.
data = await client.get_active_subscriptions_list(GetActiveSubscriptionsInput( **{ "customerId": "CUSTOMER-ID", "resourceId": "RESOURCE-ID" # optional - pass it to get subscription of specific resource }))
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.
data = await client.provision_subscription(ProvisionSubscriptionInput( **{ "customerId": "customer-id", "planId": "plan-revvenu-basic", "resourceId": "resource-01", # optional, required for multiple subscription for same product "billingPeriod": "MONTHLY", # optional, required for paid subscriptions "billableFeatures": [{ # optional, required for plans with per-unit pricing "featureId": "feature-01-templates", "quantity": 2 }], "addons": [ # optional { "addonId": "addon-extra-stuff", "quantity": 2 } ], "billingCountryCode":"DK" # optional, required for price localization, must be in the ISO-3166-1 format "checkoutOptions": { # optional "successUrl": "https://your-success-url.com", "cancelUrl": "https://your-cancel-url.com", "allowPromoCodes": True, "collectBillingAddress": True, "collectPhoneNumber": True, }, "awaitPaymentConfirmation": True, "billingInformation": { # optional "couponId": "your coupon id" }, "additionalMetaData": { # optional "key": "value" } }))
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.
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.
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 provisionSubscription() method.
{ "update_subscription": { "id": "subscription-plan-revvenu-growth-589879", "status": "ACTIVE", "metadata": null, "billing_id": "sub_1LxD4TE1gVT2zwZVSav7tZvC", "billing_link_url": "https:\/\/dashboard.stripe.com\/test\/subscriptions\/sub_1LxD4TE1gVT2zwZVSav7tZvC", "effective_end_date": null, "current_billing_period_end": "2022-11-26T17:07:17.000Z", "pricing_type": "PAID", "prices": [ { "usage_limit": 2, "price": { "billing_model": "PER_UNIT", "billing_period": "MONTHLY", "price": { "amount": 1, "currency": "USD" }, "feature": { "id": "feature-01-templates", "feature_type": "NUMBER", "meter_type": "Fluctuating", "feature_units": "template", "feature_units_plural": "templates", "display_name": "Templates", "description": null } } } ], "total_price": { "sub_total": { "amount": 17, "currency": "USD" }, "total": { "amount": 17, "currency": "USD" } }, "plan": { "id": "plan-revvenu-growth" }, "addons": [ { "quantity": 3, "addon": { "id": "addon-10-campaigns" } } ], "customer": { "id": "customer-demo-01" }, "payment_collection": "NOT_REQUIRED", // status of the payment collection of the subscription - can be either 'NOT_REQUIRED', 'FAILED', 'ACTION_REQUIRED' or 'PROCESSING' "latest_invoice": { "billingId": "invoice-01", // ID of the invoice of the billing provider "status": "PAID", // can be either 'OPEN', 'CANCELED' or 'PAID' "created_at": "2023-08-22T11:27:41.000Z", "updated_at": "2023-08-22T11:27:44.608Z", "requires_action": false, // indicate of the payment requires action to complete the payment "payment_url": "https://...", // payment url that can be sent to the customer to complete the payment "payment_secret": "secret-01", // secret to be used to initiate next action with billing provider "error_message": "", // optinal error message, if the status is FAILED } }}
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.
resp = await client.get_entitlement(FetchEntitlementQuery( **{ "customerId": "customer-id", "featureId": "feature-01-templates", "options": { "requestedUsage": 10 }, "resourceId": "resource-01", # optional, pass it to get entitlement of specific resource }))if resp.entitlement.is_granted: # customer has access to the feature passelse: # access denied pass
Used to check to what features the customer has access to, the usage limit , and the current usage of each entitlement.
data = await client.get_entitlements(FetchEntitlementsQuery( **{ "customerId": "customer-id", "resourceId": "resource-01", # optional, pass it to get entitlement of specific resource }))
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:
Calculated usage - usage that has been aggregated and calculated by your application. This type is useful for features, such as: seats.
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:
Reporting of measurements to Stigg should be done only after the relevant resources have been provisioned in your application.
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.
data = await client.report_usage(ReportUsageInput( **{ "value": 5, "customerId": "customer-id", "featureId": "feature-02-campaigns", "resourceId": "resource-01", # optional, pass it to report usage for specific resource } ))
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:
data = await client.report_usage(ReportUsageInput( ** { "value": 5, "customerId": "customer-id", "featureId": "feature-02-campaigns", "updateBehavior": "SET", "resourceId": "resource-01", # optional, pass it to report usage for specific resource }))
// report event of a user logindata = await client.report_event(UsageEventsReportInput( ** { "usageEvents": [{ "customerId": "customer-test-id", "resourceId": "resource-01", // optional, pass it to report event for specific resource "eventName": "user_login", "idempotencyKey": "227c1b73-883a-457b-b715-6ba5a2c69ce4", "dimensions": { "user_id": "user-01", "user_email": "john@example.com" }, "timestamp": "2022-10-26T15:01:55.768Z" // optional, pass it to report event with specific timestamp }] }));
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.
You can also estimate the cost of updating an existing subscription using the updateSubscription method, which also returns a breakdown of the proration amounts:
