Skip to main content
objectPaymentSubscription

Implements

Fields

amount
Int!

The amount the member is billed each period, in cents, after any coupon discount.

cancelAtPeriodEnd
Boolean!

Whether the subscription is set to end at the close of the current billing period.

canceledAt
ISO8601DateTime

When the subscription was canceled. Null while active.

completedInstallments
Int

Number of installment payments made so far. Null for subscriptions that are not paid in installments.

createdAt
ISO8601DateTime!

When the subscription record was created.

currentPeriodEnd
ISO8601DateTime

When the current billing period ends.

currentPeriodStart
ISO8601DateTime

When the current billing period started.

endedAt
ISO8601DateTime

When the subscription ended. Null while active.

gracePeriodDaysLeft
Int

Days left in the past-due grace period before access is revoked. Null unless past due; zero after the period elapses.

id
ID!

ID of the object.

isFree
Boolean!

Whether this subscription costs nothing.

member

The member who holds this subscription.

paymentPlatform

The platform the member paid through. Null for free subscriptions.

pendingPlan

The Payment Plan a pending move will switch to. Null when no move is pending.

The Payment Plan this subscription grants access to.

resourceId
ID!

Resource ID for this object, for interop with the Admin API.

start
ISO8601DateTime

When the subscription started.

Lifecycle status of the subscription. Briefly null while recovering from an interrupted payment provider sync.

taxInclusive
Boolean

Whether the billed amount includes tax. Null when tax inclusivity is not set.

trialEnd
ISO8601DateTime

When the free trial ends. Null when there was no trial.

trialStart
ISO8601DateTime

When the free trial started. Null when there was no trial.