Fetch Organization Active Subscription

Before You Begin

🔗 Use the GraphQL Playground to execute the queries in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

1. Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
2. Permissions: Ensure your token has permissions to view organization subscription information.
3. Organization ID: Identify the Organization for which you want to fetch the active subscription.

Step 1: Find Your Organization ID

1. Via Pipefy UI

• Open the Organization in your browser.
• The URL will include the Organization ID: https://app.pipefy.com/organizations/123456789.
• Organization ID = 123456789 (the number after /organizations/).

2. Via GraphQL Query

• Refer to our Get resource IDs page for alternative methods.

Step 2: Query Organization Active Subscription

Use the organization query with the activeSubscription field to retrieve details about your organization's current subscription and its limits. Below is an example:

{
  organization(id: "123") {
    id
    name
    activeSubscription {
      limits {
        resource
        limit
        used
      }
    }
  }
}

Key Fields Explained:

Organization Fields:

• id: The organization's unique identifier
• name: The organization's display name
• activeSubscription: Information about the current active subscription

Subscription Fields:

• limits: An array of subscription limits and usage information

Limit Fields:

• resource: The type of resource being limited (pipes, users, cards, records, interfaces, ai_credits)
• limit: The maximum allowed usage for this resource
• used: The current usage of this resource

Available Resource Types:

• pipes: Number of pipes in the organization
• users: Number of billable users
• cards: Number of pipe cards created per month
• records: Number of database records
• interfaces: Number of interfaces
• ai_credits: Number of AI credits available

Step 3: Execute and Interpret the Response

After running the query, you'll receive a structured JSON response. Here's an example:

{
  "data": {
    "organization": {
      "id": "2",
      "name": "Vandeley Industries",
      "activeSubscription": {
        "limits": [
          {
            "resource": "PIPES",
            "limit": 5,
            "used": 3
          },
          {
            "resource": "USERS",
            "limit": 10,
            "used": 7
          },
          {
            "resource": "CARDS",
            "limit": 50,
            "used": 12
          },
          {
            "resource": "RECORDS",
            "limit": 500,
            "used": 45
          },
          {
            "resource": "INTERFACES",
            "limit": 2,
            "used": 1
          },
          {
            "resource": "AI_CREDITS",
            "limit": 100,
            "used": 25
          }
        ]
      }
    }
  }
}

This query provides comprehensive insights into your organization's subscription status and resource utilization, enabling better planning and monitoring of your Pipefy usage.