PolarExpress.Schemas.CustomerOrder (polar_express v0.2.2)

Copy Markdown View Source

CustomerOrder

Summary

Types

t()

Functions

schema_name()

Types

t()

@type t() :: %PolarExpress.Schemas.CustomerOrder{
  applied_balance_amount: term(),
  billing_address: term(),
  billing_name: term(),
  billing_reason: term(),
  checkout_id: term(),
  created_at: term(),
  currency: term(),
  customer_id: term(),
  description: term(),
  discount_amount: term(),
  discount_id: term(),
  due_amount: term(),
  id: term(),
  invoice_number: term(),
  is_invoice_generated: term(),
  items: term(),
  modified_at: term(),
  net_amount: term(),
  next_payment_attempt_at: term(),
  paid: term(),
  product: term(),
  product_id: term(),
  refunded_amount: term(),
  refunded_tax_amount: term(),
  seats: term(),
  status: term(),
  subscription: term(),
  subscription_id: term(),
  subtotal_amount: term(),
  tax_amount: term(),
  total_amount: term()
}
  • applied_balance_amount - Customer's balance amount applied to this invoice. Can increase the total amount paid, if the customer has a negative balance, or decrease it, if the customer has a positive balance.Amount in cents.
  • billing_address - Nullable.
  • billing_name - The name of the customer that should appear on the invoice. Nullable.
  • billing_reason
  • checkout_id - Nullable.
  • created_at - Creation timestamp of the object. Format: date-time.
  • currency
  • customer_id - Format: uuid4.
  • description - A summary description of the order.
  • discount_amount - Discount amount in cents.
  • discount_id - Nullable.
  • due_amount - Amount in cents that is due for this order.
  • id - The ID of the object. Format: uuid4.
  • invoice_number - The invoice number associated with this order.
  • is_invoice_generated - Whether an invoice has been generated for this order.
  • items - Line items composing the order.
  • modified_at - Last modification timestamp of the object. Nullable.
  • net_amount - Amount in cents, after discounts but before taxes.
  • next_payment_attempt_at - When the next payment retry is scheduled Nullable.
  • paid - Whether the order has been paid for.
  • product - Nullable.
  • product_id - Nullable.
  • refunded_amount - Amount refunded in cents.
  • refunded_tax_amount - Sales tax refunded in cents.
  • seats - Number of seats purchased (for seat-based one-time orders). Nullable.
  • status
  • subscription - Nullable.
  • subscription_id - Nullable.
  • subtotal_amount - Amount in cents, before discounts and taxes.
  • tax_amount - Sales tax amount in cents.
  • total_amount - Amount in cents, after discounts and taxes.

Functions

schema_name()