Represents a user's subscription record, containing billing status, pricing details, and lifecycle timing within a specific merchant account.
The collection of add-ons associated with this subscription.
balanceAmount!Non-nullThe amount of outstanding charges associated with a subscription.
descriptorRecurringThe descriptive value on bank statements. This value may comprise static or dynamic information, and is passed on a per-transaction basis.
The collection of discounts associated with this subscription.
idID!Non-nullThe unique identifier for this subscription.
legacyID!Non-nullThe legacy subscription identifier.
merchantIDThe merchant account ID used for the subscription.
nextAmountThe total subscription amount for the next billing period. This amount includes add-ons and discounts but does not include the current balance.
paymentIDThe payment method to use for this subscription. Accepts single-use or vaulted payment methods.
planID!Non-nullThe plan identifier.
priceAmount!Non-nullThe base price and currency for this subscription.
statusRecurringThe current lifecycle state of the subscription.
status[RecurringArray of up to 50 subscription history events.
timelineRecurringTimeline information including billing dates and payment status.
transaction[ID!]IDs of transactions associated with the subscription, sorted by creation date with the most recent first. When returned in a subscription webhook, this array contains only the 20 most recent transaction IDs; otherwise, it contains all transaction IDs associated with the subscription.
Trial period settings for this subscription. Empty indicates there is no trial.
type RecurringBillingSubscription implements Node {
id: ID!
legacyId: ID!
payPalDescription: String
status: RecurringBillingSubscriptionStatus!
price: Amount!
balance: Amount!
billingDayOfMonth: Int!
currentBillingCycle: Int!
numberOfBillingCycles: Int
failureCount: Int!
daysPastDue: Int
timeline: RecurringBillingSubscriptionTimeline!
nextBillingPeriodAmount: Amount
trial: RecurringBillingSubscriptionTrial
descriptor: RecurringBillingSubscriptionDescriptor
planId: ID!
paymentMethodId: ID
merchantAccountId: ID
addOns: [RecurringBillingSubscriptionAddOn!]
discounts: [RecurringBillingSubscriptionDiscount!]
transactionIds: [ID!]
statusHistory: [RecurringBillingSubscriptionStatusEvent!]
}