Skip to main content
GET
/
api
/
v1
/
subscriptions
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const subscriptionListResponse of client.v1.subscriptions.list()) {
  console.log(subscriptionListResponse.id);
}
{
  "data": [
    {
      "id": "<string>",
      "customerId": "<string>",
      "billingId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "startDate": "2023-11-07T05:31:56Z",
      "status": "PAYMENT_PENDING",
      "pricingType": "FREE",
      "paymentCollection": "NOT_REQUIRED",
      "planId": "<string>",
      "payingCustomerId": "<string>",
      "resourceId": "<string>",
      "endDate": "2023-11-07T05:31:56Z",
      "effectiveEndDate": "2023-11-07T05:31:56Z",
      "cancellationDate": "2023-11-07T05:31:56Z",
      "trialEndDate": "2023-11-07T05:31:56Z",
      "cancelReason": "UPGRADE_OR_DOWNGRADE",
      "metadata": {},
      "currentBillingPeriodStart": "2023-11-07T05:31:56Z",
      "currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
      "paymentCollectionMethod": "CHARGE",
      "billingCycleAnchor": "2023-11-07T05:31:56Z",
      "prices": [],
      "addons": [],
      "coupons": [],
      "futureUpdates": [],
      "budget": {
        "limit": 123,
        "hasSoftLimit": true
      },
      "minimumSpend": {
        "amount": 123,
        "currency": "usd"
      },
      "subscriptionEntitlements": [],
      "latestInvoice": {
        "billingId": "<string>",
        "status": "OPEN",
        "createdAt": "2023-11-07T05:31:56Z",
        "requiresAction": true,
        "total": 123,
        "amountDue": 123,
        "currency": "<string>",
        "pdfUrl": "<string>",
        "billingReason": "BILLING_CYCLE"
      },
      "trial": {
        "trialEndBehavior": "CONVERT_TO_PAID"
      }
    }
  ],
  "pagination": {
    "next": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prev": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.stigg.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Query Parameters

​
after
string<uuid>

Return items that come after this cursor

​
before
string<uuid>

Return items that come before this cursor

​
limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
​
customerId
string

Filter by customer ID

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$
​
status
enum<string>[]

Filter by subscription status. Supports comma-separated values for multiple statuses

Available options:
PAYMENT_PENDING,
ACTIVE,
EXPIRED,
IN_TRIAL,
CANCELED,
NOT_STARTED
​
planId
string

Filter by plan ID

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$
​
resourceId
string

Filter by resource ID

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$
​
pricingType
enum<string>[]

Filter by pricing type. Supports comma-separated values for multiple types

Available options:
FREE,
PAID,
CUSTOM
​
createdAt
object

Filter by creation date using range operators: gt, gte, lt, lte

Response

A paginated list of subscription objects.

Response list object

​
data
Subscription · object[]
required
​
pagination
object
required

Pagination metadata including cursors for navigating through results