Skip to main content

OrganizationBilling

Subscription, trial, and upgrade information for an organization.

Returned by Organization.billing for organization administrators only. Non-admin members will see null here even when they can otherwise view the organization.

type OrganizationBilling {
  seats: Int!
  seatsUsed: Int!
  cost: Int
  currency: String
  frequency: BillingFrequency
  affiliate: String
  trialEndsAt: DateTime
  planExpiresOn: Date
  portalUrl: String!
  plans: [BillingPlan!]!
}

Fields​

OrganizationBilling.seats ● Int! non-null scalar {#seats}​

Number of seats currently provisioned on the subscription (the org's max member count).

OrganizationBilling.seatsUsed ● Int! non-null scalar {#seats-used}​

Number of members who hold a seat (see Account.holdsSeat). A member added by the identity provider holds a seat while the identity provider marks them active and they match the SCIM integration's seat rule, if it has one. A member added in Massdriver holds a seat while they are in at least one group. A pending invitation holds no seat.

Can exceed seats for organizations that held more seats than their plan when seats were introduced. The value is reported as-is rather than capped. When seatsUsed >= seats, accepting an invitation is refused and identity provider users who become active wait for a seat.

OrganizationBilling.cost ● Int scalar {#cost}​

Current subscription cost for the full billing period, expressed in the smallest subunit of currency (e.g., cents for USD). null if the org is not on a paid plan.

OrganizationBilling.currency ● String scalar {#currency}​

ISO 4217 currency code for cost (e.g., USD). null if the org is not on a paid plan.

OrganizationBilling.frequency ● BillingFrequency enum {#frequency}​

Cadence the org is currently billed at. null if the org is not on a paid plan.

OrganizationBilling.affiliate ● String scalar {#affiliate}​

Friendly attribution name for the partner that referred this org (e.g., "Y Combinator").

OrganizationBilling.trialEndsAt ● DateTime scalar {#trial-ends-at}​

When the current free trial expires (UTC). null once subscriptionStatus is anything other than TRIAL.

OrganizationBilling.planExpiresOn ● Date scalar {#plan-expires-on}​

End date of the current paid plan or grace period. null when not applicable (e.g., monthly plans).

OrganizationBilling.portalUrl ● String! non-null scalar {#portal-url}​

Stripe Customer Portal URL for managing payment methods, invoices, and cancellation.

OrganizationBilling.plans ● [BillingPlan!]! non-null object {#plans}​

Plans the organization can upgrade or switch to. URLs are prefilled with this org's reference for one-click checkout.

Member Of​

Organization object