GraphQL API
Organization API
Organization / Types/ object

BillingSubscription

A subscription of the company

Fields

11 fields
canceledAt•DateTime

When the subscription was canceled.

createdAt•DateTimeTz!

When the subscription was created.

currentCycleEndsAt•DateTimeTz

Current billing cycle ends at

currentCycleStartedAt•DateTimeTz

Current billing cycle started at

expiredAt•DateTime

When the subscription was expired.

id•ID!

Unique primary key.

isTrial•Boolean!

Is Trial

code•String!

Code of the plan

description•String!

Description of the plan

id•ID!

Unique primary key.

isActive•Boolean!

Active

name•String!

Name of the plan

edges•[TierEdge!]!

A list of Tier edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

unitType•String!

Billing unit type

Status of the subscription

ACTIVECANCELEDEXPIREDPENDINGSCHEDULEDSUSPENDED
currency•String!

ISO 4217 currency code

value•String!

Amount

id•ID!

Unique primary key.

currency•String!

ISO 4217 currency code

value•String!

Amount

upTo•Int!

Quantity included

updatedAt•DateTimeTz!

When the subscription was last updated.