VoucherConfiguration

View normalized Markdown

VoucherConfiguration data available to a scoped Management API integration.

graphql

type VoucherConfiguration {
  createdAt: DateTime!
  currency: String
  description: String
  discardedAt: DateTime
  hidden: Boolean
  id: ID!
  name: String
  number: String
  priceValueCents: BigInt
  publishedAt: DateTime
  singleUse: Boolean
  tombstone: Boolean!
  updatedAt: DateTime!
  voucherType: String
}

Fields

`VoucherConfiguration.createdAt` · `DateTime!` non-null scalar

Record creation timestamp.

`VoucherConfiguration.currency` · `String` scalar

Currency.

`VoucherConfiguration.description` · `String` scalar

Description.

`VoucherConfiguration.discardedAt` · `DateTime` scalar

When the record was discarded; null for an active record.

`VoucherConfiguration.hidden` · `Boolean` scalar

Hidden.

`VoucherConfiguration.id` · `ID!` non-null scalar

Stable record identifier.

`VoucherConfiguration.name` · `String` scalar

Display name when the resource provides one.

`VoucherConfiguration.number` · `String` scalar

External-facing record number when the resource provides one.

`VoucherConfiguration.priceValueCents` · `BigInt` scalar

Price value cents.

`VoucherConfiguration.publishedAt` · `DateTime` scalar

Published at.

`VoucherConfiguration.singleUse` · `Boolean` scalar

Single use.

`VoucherConfiguration.tombstone` · `Boolean!` non-null scalar

True when the discarded record represents a removal to propagate locally.

`VoucherConfiguration.updatedAt` · `DateTime!` non-null scalar

Timestamp used for incremental synchronization and cursor ordering.

`VoucherConfiguration.voucherType` · `String` scalar

Voucher type.

Returned By

voucherConfiguration query

Member Of

VoucherConfigurationCollection object