Search documentation of polar_express

# PolarExpress.Resources.CustomerPortal.Orders (polar_express v0.1.5)

Copy Markdown View Source

Orders

Orders API operations.

## Summary

### Types

t()

### Functions

object_name()

## Types

# t()

    @type t() :: %PolarExpress.Resources.CustomerPortal.Orders{
      applied_balance_amount: integer() | nil,
      billing_address: term() | nil,
      billing_name: term() | nil,
      billing_reason: map() | nil,
      checkout_id: term() | nil,
      created_at: String.t() | nil,
      currency: String.t() | nil,
      customer_id: String.t() | nil,
      description: String.t() | nil,
      discount_amount: integer() | nil,
      discount_id: term() | nil,
      due_amount: integer() | nil,
      id: String.t() | nil,
      invoice_number: String.t() | nil,
      is_invoice_generated: boolean() | nil,
      items: [map()] | nil,
      modified_at: term() | nil,
      net_amount: integer() | nil,
      next_payment_attempt_at: term() | nil,
      paid: boolean() | nil,
      product: term() | nil,
      product_id: term() | nil,
      refunded_amount: integer() | nil,
      refunded_tax_amount: integer() | nil,
      seats: term() | nil,
      status: map() | nil,
      subscription: term() | nil,
      subscription_id: term() | nil,
      subtotal_amount: integer() | nil,
      tax_amount: integer() | nil,
      total_amount: integer() | nil,
      user_id: String.t() | nil
    }

- `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`
- `billing_name` - The name of the customer that should appear on the invoice.
- `billing_reason`
- `checkout_id`
- `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`
- `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.
- `net_amount` - Amount in cents, after discounts but before taxes.
- `next_payment_attempt_at` - When the next payment retry is scheduled
- `paid` - Whether the order has been paid for.
- `product`
- `product_id`
- `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).
- `status`
- `subscription`
- `subscription_id`
- `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.
- `user_id` - Format: uuid4. Deprecated.

## Functions

# object_name()