GraphQL OBJECT

Purchase

Transaction data related to the purchase.

link Definition

  • type Purchase {
  • # Person or company that purchases the software or signs up for the subscription.
  • # Contact information used for communication about payments.
  • billingContact: Contact
  • # Link for a customer to change their payment information.
  • changePaymentUrl: String
  • # Client who offers the product for sale.
  • client: Client
  • # Coupon code for a cart level promotion associated with the purchase.
  • couponCode: String
  • # URL where the customer's confirmation page is located.
  • confirmationPageUrl: String
  • # Customer who made the purchase.
  • customer: Customer
  • # The country of the customer.
  • customerCountry: Country
  • # Currency used by the customer.
  • customerCurrency: Currency
  • # Pricing information that the customer receives during the purchase process.
  • customerPricing: Pricing
  • # Gross price of the customer in Euro.
  • customerGrossEuro: CurrencyAmount
  • # Purchase order number of the customer.
  • customerPurchaseOrderNo: String
  • # Person or company to whom the software or service is delivered. Contact
  • # information used for physical shipments, electronic delivery and communication
  • # concerning the delivery of licensing information.
  • deliveryContact: Contact
  • # List of emails generated for the purchase.
  • emails: [Email]
  • # URL where the customer started the checkout process.
  • entryUrl: String
  • # List of errors that occurred during the purchase process.
  • errors: [ErrorLogEntry]
  • # List of x-parameters used in the transaction. For more information, see [About
  • # X-Parameters](https://docs.cleverbridge.com/public/all/using-the-platform/about-x-parameters.htm).
  • extraParameters: [ExtraParameter]
  • # List of follow-ups for the purchase. These are reminders about open product and
  • # purchase issues.
  • followUps: [FollowUp]
  • # List of history entries for the purchase. These are detailed notes about the
  • # customer interactions and transaction events that occurred after an initial
  • # purchase.
  • historyEntries: [HistoryEntry]
  • # Unique id of the purchase.
  • id: Int
  • # The country of the ip.
  • ipCountry: Country
  • # List of purchase items.
  • items: [PurchaseItem]
  • # Indicates if the purchase is a test order.
  • isTestOrder: Boolean
  • # Person or company that the software license is registered to. Contact
  • # information used for the generation of licensing information.
  • licenseeContact: Contact
  • # Metadata for current purchase status.
  • metaData: PurchaseMetaData
  • # Date and time when the order was placed.
  • orderDate: DateTime
  • # How often the payment info has been changed.
  • paymentChangedCount: Int
  • # The country of the payment.
  • paymentCountry: Country
  • # Date and time when cleverbridge received payment.
  • paymentDate: DateTime
  • # Cart level promotion associated with the purchase.
  • promotion: Promotion
  • # Client policy and procedures for purchase orders.
  • purchaseOrderPolicy: ClientPolicy
  • # Payment profile of the customer.
  • paymentProfile: PaymentProfileInterface
  • # URL the customer was referred from.
  • refererUrl: String
  • # Client policy and procedures for refunds.
  • refundPolicy: ClientPolicy
  • # Date and time of latest reimbursement.
  • reimbursementDate: DateTime
  • # Status of the purchase.
  • status: PurchaseStatus
  • # The country of taxation.
  • taxationCountry: Country
  • # List of transactions.
  • transactions: [PurchaseTransaction]
  • # The VAT ID.
  • vatId: String @deprecated( reason: "Replaced by taxTypes." )
  • # The tax types.
  • taxTypes: [ContactTaxType]
  • # List of journal items.
  • journalItems: [JournalItem]
  • # The business model.
  • businessModel: BusinessModel
  • }