Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Stigg home page

Status
Product updates
Go to Stigg
Go to Stigg

Overview

REST API Overview
API Keys
Rate Limits
Edge API Rate Limits
Using Stigg at Scale

SDKs

Subscriptions

GET
Get a single subscription by ID
PATCH
Update a subscription
GET
Get a list of subscriptions
POST
Provision subscription
POST
Transfer subscription to resource
POST
Migrate subscription to latest plan version
POST
Delegate subscription payment to customer
DEL
Cancel pending payment update
DEL
Cancel scheduled update
POST
Preview subscription
POST
Cancel subscription
POST
Charge subscription usage
POST
Trigger subscription usage sync
POST
Mark subscription invoice as paid

Bulk Import

POST
Bulk import subscriptions
POST
Bulk import customers

Usage

GET
Get usage history
POST
Report usage events
POST
Report usage measurements

Coupons

GET
Get a list of coupons
POST
Create coupon
GET
Get a single coupon by ID
PATCH
Update a coupon
POST
Archive coupon

Products

GET
Get a list of products
POST
Create product
PATCH
Update a product
POST
Archive product
POST
Unarchive product
POST
Duplicate product

Features

GET
Get a single feature by ID
PATCH
Update a feature
GET
Get a list of features
POST
Create a feature
POST
Archive feature
POST
Unarchive feature

Addons

GET
Get a list of addons
POST
Create an addon
GET
Get a single addon by ID
PATCH
Update a addon
POST
Archive an addon
GET
List addon charges
POST
Create addon draft
DEL
Remove addon draft
POST
Publish addon

Plans

GET
Get a list of plans
POST
Create plan
GET
Get a single plan by ID
PATCH
Update a plan
POST
Archive plan
GET
List plan charges
GET
List plan overage charges
POST
Create plan draft
DEL
Remove plan draft
POST
Publish plan

Promotional Entitlements

GET
Get a list of promotional entitlements
POST
Create a promotional entitlements
DEL
Revoke promotional entitlement

Customers

GET
Get a list of customer resources
GET
Get a single customer by ID
PATCH
Update a customer
GET
Get a list of customers
POST
Provision customer
POST
Archive customer
POST
Unarchive customer
POST
Attach payment method
DEL
Detach payment method

Customer Integrations

GET
Get a list of customer integrations
POST
Link customer integration
GET
Get a single customer integration by ID
DEL
Unlink customer integration
PATCH
Update a customer integration

Data Export

POST
Add data-export destination
DEL
Remove data-export destination
POST
Trigger data-export sync
POST
Mint data-export scoped token

Entitlements

GET
Get entitlements state
GET
Check entitlement

Beta - Entitlements

GET
Check entitlement (beta)

Beta - Entities

GET
Get a list of entitys
PUT
Upsert entities
GET
Get a single entity by ID
POST
Archive entities
POST
Unarchive entities

Plan Entitlements

GET
Get a list of plan entitlements
POST
Create plan entitlements
DEL
Delete plan entitlement
PATCH
Update a plan entitlement

Addon Entitlements

GET
Get a list of addon entitlements
POST
Create addon entitlements
DEL
Delete addon entitlement
PATCH
Update a addon entitlement

Credit grants

GET
Get a list of credit grants
POST
Create a credit grant
POST
Void credit grant

Credit usage

GET
Get credit usage

Auto recharge

GET
Get automatic recharge configuration

Custom currencies

GET
Get a list of custom currencys
POST
Create custom currency
PATCH
Update custom currency
POST
Archive custom currency
POST
Unarchive custom currency
GET
List custom currency associated entities

Credit ledger

GET
Get a list of credit ledger events

Beta - EntityTypes

GET
Get a list of entity types
PUT
Upsert entity types

Beta - Assignments

GET
Get a list of assignments
PUT
Upsert assignments

Backend SDK

Ruby SDK

Ruby SDK reference

Explore the full SDK reference and documentation

⌘I

website twitter linkedin

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.