RollerupSubscription

RollerupSubscription

Kind: Object

Fields

Field Type Description
billingCustomerId String Latest billing provider customer ID (e.g., Stripe ‘cus_…’) associated with this subscription
billingFrequency String! Billing frequency
billingSubscriptionId String Latest billing provider subscription ID (e.g., Stripe ‘sub_…’) associated with this subscription
cancelAt DateTime Timestamp when the subscription is scheduled to be cancelled
cancelledAt DateTime Timestamp when the subscription was cancelled
createdAt DateTime! Timestamp when the subscription was created
currentPeriodEnd DateTime! Current period end
currentPeriodStart DateTime! Current period start
customer RollerupCustomer Customer for this subscription
customerId String Customer ID
defaultPaymentMethod PaymentMethod Default payment method for this subscription
id String! Subscription ID
isExternallyManaged Boolean! Whether the subscription is managed by an external billing system (e.g. drb). Externally-managed subscriptions cannot be edited via the API.
location Location Current location for this subscription
locationId String Current location ID associated with this subscription
memberships [Membership!]! Memberships belonging to this subscription
soldAtLocation SimpleLocation Location where this subscription was sold
soldAtLocationId String Location ID where this subscription was sold
soldBy User Employee who sold this subscription
soldById String Employee ID who sold this subscription
startedAt DateTime Timestamp when the subscription started
status String! Status of this subscription

Definition

type RollerupSubscription {
  """
  Latest billing provider customer ID (e.g., Stripe 'cus_...') associated with this subscription
  """
  billingCustomerId: String
  """Billing frequency"""
  billingFrequency: String!
  """
  Latest billing provider subscription ID (e.g., Stripe 'sub_...') associated with this subscription
  """
  billingSubscriptionId: String
  """Timestamp when the subscription is scheduled to be cancelled"""
  cancelAt: DateTime
  """Timestamp when the subscription was cancelled"""
  cancelledAt: DateTime
  """Timestamp when the subscription was created"""
  createdAt: DateTime!
  """Current period end"""
  currentPeriodEnd: DateTime!
  """Current period start"""
  currentPeriodStart: DateTime!
  """Customer for this subscription"""
  customer: RollerupCustomer
  """Customer ID"""
  customerId: String
  """Default payment method for this subscription"""
  defaultPaymentMethod: PaymentMethod
  """Subscription ID"""
  id: String!
  """
  Whether the subscription is managed by an external billing system (e.g. drb). Externally-managed subscriptions cannot be edited via the API.
  """
  isExternallyManaged: Boolean!
  """Current location for this subscription"""
  location: Location
  """Current location ID associated with this subscription"""
  locationId: String
  """Memberships belonging to this subscription"""
  memberships: [Membership!]!
  """Location where this subscription was sold"""
  soldAtLocation: SimpleLocation
  """Location ID where this subscription was sold"""
  soldAtLocationId: String
  """Employee who sold this subscription"""
  soldBy: User
  """Employee ID who sold this subscription"""
  soldById: String
  """Timestamp when the subscription started"""
  startedAt: DateTime
  """Status of this subscription"""
  status: String!
}