struct

Polar::Models::Order

Inherits JSON::Serializable < Struct < Value < Object

Model representing a Order

This struct is auto-generated from the Polar.sh OpenAPI specification. It uses JSON::Serializable for automatic JSON parsing and serialization.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

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.

Source
billing_address
Source
billing_name

The name of the customer that should appear on the invoice.

Source
billing_reason
Source
checkout_id
Source
created_at

Creation timestamp of the object.

Source
currency
Source
custom_field_data

Key-value object storing custom field values.

Source
customer
Source
customer_id
Source
description

A summary description of the order.

Source
discount
Source
discount_amount

Discount amount in cents.

Source
discount_id
Source
due_amount

Amount in cents that is due for this order.

Source
id

The ID of the object.

Source
invoice_number

The invoice number associated with this order.

Source
is_invoice_generated

Whether an invoice has been generated for this order.

Source
items

Line items composing the order.

Source
metadata
Source
modified_at

Last modification timestamp of the object.

Source
net_amount

Amount in cents, after discounts but before taxes.

Source
platform_fee_amount

Platform fee amount in cents.

Source
product
Source
product_id
Source
refunded_amount

Amount refunded in cents.

Source
refunded_tax_amount

Sales tax refunded in cents.

Source
seats

Number of seats purchased (for seat-based one-time orders).

Source
status
Source
subscription
Source
subscription_id
Source
subtotal_amount

Amount in cents, before discounts and taxes.

Source
tax_amount

Sales tax amount in cents.

Source
total_amount

Amount in cents, after discounts and taxes.

Source
user_id
Source