Organization Subscriptions

Organization subscriptions represent the current pricing plan and active feature entitlements for an organization.

Query subscription details to determine which modules and limits apply — such as maximum seats, advanced reporting, or resource planning. Subscriptions reflect the organization's billing tier and control access to premium features.

Attributes

active_products object
Response Request

The list of currently active product modules enabled on this subscription.

balance object
Response

The account's current Stripe balance in cents (negative means credit).

billing_address object
Response Request

The billing address on file for this organization's subscription.

billing_email object
Response Request

The email address used for billing communications and invoices.

billing_group_admin boolean
Response

Whether this organization is the admin of a billing group (manages billing for member organizations).

billing_group_member object
Response

Whether this organization is a member of a billing group managed by another organization.

billing_group_members array of organization subscription
Response

Organizations in the billing group managed by this organization, if it is a billing group admin.

billing_group_owner organization subscription
Response

The billing group owner organization, if this organization is a billing group member.

billing_group_seats integer
Response Request

Total number of seats across all organizations in this billing group.

card_brand string
Response

The brand of the credit or debit card on file (e.g. Visa, Mastercard).

card_last4 string
Response

The last four digits of the credit or debit card on file.

card_month string
Response

The expiry month of the card on file.

card_year string
Response

The expiry year of the card on file.

collection_method_id integer
Response Enum

ID of the collection method used to charge this subscription (e.g., charge automatically or send invoice).

Enum Values (2 values)

  • 1
    Charge Automatically
  • 2
    Send Invoice
contract_date string
Response

The date the contract with this organization started.

contract_min_seats integer
Response

The minimum number of seats specified in the organization's contract.

contract_seats integer
Response

The number of seats specified in the organization's current contract.

current_plan object
Response

The organization's current billing plan details.

current_products object
Response

The list of product modules currently active on the subscription.

discount integer
Response

The discount percentage applied to the subscription price.

discount_expires_on string
Response

Date when the current discount expires, or null if it does not expire.

grace_period_ends_at string
Response

The grace period ends at.

next_billing_cycle_at string
Response

The next billing cycle at.

organization organization
Response

The organization this subscription belongs to.

payment_method_id integer
Response Enum

ID of the payment method on file for this subscription.

Enum Values (2 values)

  • 1
    Credit Card
  • 2
    Invoice
plan_cycle object
Response Request

The billing cycle of the plan (monthly or annual).

plan_price object
Response

The price per seat per billing cycle for the current plan, after discount.

plan_type object
Response Request

The type identifier of the current plan (e.g. essential, professional, ultimate).

product_types array of object
Response Request

The list of product module types included in the subscription.

seats integer
Response Request

The total number of seats purchased for this subscription.

seats_pending object
Response

The number of seats with a pending change (e.g. scheduled to be added or removed).

seats_used integer
Response

The number of seats currently occupied by active members.

stripe_customer_id integer
Response

The Stripe customer ID associated with this organization's billing account.

stripe_token object
Request

The Stripe payment token used to update the payment method on file.

subscription_ended_at string
Response

Timestamp when the subscription ended, or null if still active.

subscription_started_at string
Response

Timestamp when the subscription started.

subscription_state_id integer
Response Enum

ID of the current subscription state (e.g. active, trialing, past_due, canceled).

Enum Values (8 values)

  • 1
    Trialing
  • 2
    Active
  • 3
    Past Due
  • 4
    Canceled
  • 5
    Unpaid
  • 6
    Active until period end
  • 8
    Incomplete
  • 9
    Incomplete expired
trial_ends_at string
Response

Timestamp when the free trial ends, or null if not on a trial.

trial_plan_active object
Response

Whether a trial plan upgrade is currently active for this organization.

trial_plan_ends_at string
Response

The trial plan ends at.

trial_plan_type object
Response Request

The type of plan being trialed, if a trial plan upgrade is active.

trial_product_ids object
Response Request

List of product IDs included in the trial subscription for this organization.