PrepaidCode

PrepaidCode

Represents a prepaid code that can be redeemed for a prepaid

Kind: Object

Fields

Field Type Description
activatedAt DateTime When this code was activated (null if not yet activated)
code String! The code string that is typically scanned but can also be manually entered
companyId ID! The company this prepaid code belongs to
createdAt DateTime! Timestamp when the prepaid code was created
drbBook Int DRB book number
drbSeries String DRB series identifier
drbTicket Int DRB ticket number
id ID! Unique identifier for the prepaid code
maxRedemptions Int Maximum number of times this code can be redeemed
overwritten Boolean! Whether this code’s containing book has been overwritten by a colliding DRB import. Always false for codes not in a book.
prepaid Prepaid! The prepaid this code applies to
prepaidBookId ID The prepaid book ID this code belongs to (null if not part of a book)
prepaidExport SimplePrepaidExport The export this code was included in (null if never exported)
prepaidId ID! The prepaid this code applies to
redemptions [PrepaidCodeRedemption!]! List of redemptions for this prepaid code (limited by maxRedemptionsPerPrepaid)
redemptionsCount Int! Total count of redemptions for this prepaid code
updatedAt DateTime! Timestamp when the prepaid code was last updated

Definition

"""Represents a prepaid code that can be redeemed for a prepaid"""
type PrepaidCode {
  """When this code was activated (null if not yet activated)"""
  activatedAt: DateTime
  """
  The code string that is typically scanned but can also be manually entered
  """
  code: String!
  """The company this prepaid code belongs to"""
  companyId: ID!
  """Timestamp when the prepaid code was created"""
  createdAt: DateTime!
  """DRB book number"""
  drbBook: Int
  """DRB series identifier"""
  drbSeries: String
  """DRB ticket number"""
  drbTicket: Int
  """Unique identifier for the prepaid code"""
  id: ID!
  """Maximum number of times this code can be redeemed"""
  maxRedemptions: Int
  """
  Whether this code's containing book has been overwritten by a colliding DRB import. Always false for codes not in a book.
  """
  overwritten: Boolean!
  """The prepaid this code applies to"""
  prepaid: Prepaid!
  """The prepaid book ID this code belongs to (null if not part of a book)"""
  prepaidBookId: ID
  """The export this code was included in (null if never exported)"""
  prepaidExport: SimplePrepaidExport
  """The prepaid this code applies to"""
  prepaidId: ID!
  """
  List of redemptions for this prepaid code (limited by maxRedemptionsPerPrepaid)
  """
  redemptions: [PrepaidCodeRedemption!]!
  """Total count of redemptions for this prepaid code"""
  redemptionsCount: Int!
  """Timestamp when the prepaid code was last updated"""
  updatedAt: DateTime!
}