-
Notifications
You must be signed in to change notification settings - Fork 4
Order_Attributes
An object representing the resources data.
public struct Attributes: Codable
Codable
The ID of the store this order belongs to.
public let storeId: Int
The ID of the customer this subscription belongs to.
public let customerId: Int
The unique identifier (UUID) for this order.
public let identifier: String
An integer representing the sequential order number for this store.
public let orderNumber: Int
The full name of the customers.
public let userName: String
The email address of the customer.
public let userEmail: String
The ISO 4217 currency code for the order (e.g. USD
, GBP
etc.).
public let currency: String
If the order currency is USD, this will always be 1.0
. Otherwise, this is the currency conversion rate used to determine the cost of the order in USD at the time of purchase.
public let currencyRate: String
A positive integer in cents representing the subtotal of the order in the order currency.
public let subtotal: Int
A positive integer in cents representing the total discount value applied to the order in the order currency.
public let discountTotal: Int
A positive integer in cents representing the tax applied to the order in the order currency.
public let tax: Int
A positive integer in cents representing the total cost of the order in the order currency.
public let total: Int
A positive integer in cents representing the subtotal of the order in USD.
public let subtotalUsd: Int
A positive integer in cents representing the total discount value applied to the order in USD.
public let discountTotalUsd: Int
A positive integer in cents representing the tax applied to the order in USD.
public let taxUsd: Int
A positive integer in cents representing the total cost of the order in USD.
public let totalUsd: Int
If tax is applied to the order, this will be the name of the tax rate (e.g. VAT
, Sales Tax
, etc).
public let taxName: String?
If tax is applied to the order, this will be the rate of tax as a decimal percentage.
public let taxRate: String
The status of the order. One of pending
, failed
, paid
, refunded
.
public let status: String
The formatted status of the order.
public let statusFormatted: String
Has the value true if the order has been refunded.
public let refunded: Int
If the order has been refunded, this will be an ISO-8601 formatted date-time string indicating when the order was refunded.
public let refundedAt: String?
A human-readable string representing the subtotal of the order in the order currency (e.g. $9.99).
public let subtotalFormatted: String
A human-readable string representing the total discount value applied to the order in the order currency (e.g. $9.99).
public let discountTotalFormatted: String
A human-readable string representing the tax applied to the order in the order currency (e.g. $9.99).
public let taxFormatted: String
A human-readable string representing the total cost of the order in the order currency (e.g. $9.99).
public let totalFormatted: String
An object representing the first order item belonging to this order.
public let firstOrderItem: FirstOrderItem
An ISO-8601 formatted date-time string indicating when the object was created.
public let createdAt: String
An ISO-8601 formatted date-time string indicating when the object was last updated.
public let updatedAt: String
Generated at 2023-03-27T19:40:46+0000 using swift-doc 1.0.0-rc.1.
Types
- ActivateLicense
- ActivateLicense.Instance
- ActivateLicense.LicenseKey
- ActivateLicense.Meta
- Checkout
- Checkout.APIResponse
- Checkout.Attributes
- Checkout.CheckoutData
- Checkout.CheckoutData.BillingAddress
- Checkout.CheckoutOptions
- Checkout.Included
- Checkout.ProductOptions
- Customer
- Customer.APIResponse
- Customer.Attributes
- Customer.Included
- DeactivateLicense
- DeactivateLicense.LicenseKey
- DeactivateLicense.Meta
- Discount
- Discount.APIResponse
- Discount.Attributes
- Discount.Included
- DiscountRedemption
- DiscountRedemption.APIResponse
- DiscountRedemption.Attributes
- DiscountRedemption.Included
- ErrorDetail
- File
- File.APIResponse
- File.Attributes
- File.Included
- LemonSqueezy
- LemonSqueezyAPIDataAndIncluded
- LemonSqueezyAPIDataIncludedAndMeta
- LemonSqueezyAPIError
- LemonSqueezyError
- LicenseKey
- LicenseKey.APIResponse
- LicenseKey.Attributes
- LicenseKey.Included
- LicenseKeyInstance
- LicenseKeyInstance.APIResponse
- LicenseKeyInstance.Attributes
- LicenseKeyInstance.Included
- Meta
- Meta.Page
- Order
- Order.APIResponse
- Order.Attributes
- Order.FirstOrderItem
- Order.Included
- OrderItem
- OrderItem.APIResponse
- OrderItem.Attributes
- OrderItem.Included
- Product
- Product.APIResponse
- Product.Attributes
- Product.Included
- Store
- Store.APIResponse
- Store.Attributes
- Store.Included
- Subscription
- Subscription.APIResponse
- Subscription.Attributes
- Subscription.Included
- Subscription.Pause
- Subscription.Urls
- User
- User.APIResponse
- User.Attributes
- User.Included
- ValidateLicense
- ValidateLicense.Instance
- ValidateLicense.LicenseKey
- ValidateLicense.Meta
- Variant
- Variant.APIResponse
- Variant.Attributes
- Variant.Included
Global Functions
- activateLicense(licenseKey:instanceName:)
- cancelSubscription(_:)
- createCheckout(body:)
- deactivateLicense(licenseKey:instanceId:)
- getCheckout(_:queryItems:)
- getCheckouts(pageNumber:pageSize:queryItems:)
- getCustomer(_:queryItems:)
- getCustomers(pageNumber:pageSize:queryItems:)
- getDiscount(_:queryItems:)
- getDiscountRedemption(_:queryItems:)
- getDiscountRedemptions(pageNumber:pageSize:queryItems:)
- getDiscounts(pageNumber:pageSize:queryItems:)
- getFile(_:queryItems:)
- getFiles(pageNumber:pageSize:queryItems:)
- getLicenseKey(_:queryItems:)
- getLicenseKeyInstance(_:queryItems:)
- getLicenseKeyInstances(pageNumber:pageSize:queryItems:)
- getLicenseKeys(pageNumber:pageSize:queryItems:)
- getMe()
- getOrder(_:queryItems:)
- getOrderItem(_:queryItems:)
- getOrderItems(pageNumber:pageSize:queryItems:)
- getOrders(pageNumber:pageSize:queryItems:)
- getProduct(_:queryItems:)
- getProducts(pageNumber:pageSize:queryItems:)
- getStore(_:queryItems:)
- getStores(pageNumber:pageSize:queryItems:)
- getSubscription(_:queryItems:)
- getSubscriptions(pageNumber:pageSize:queryItems:)
- getVariant(_:queryItems:)
- getVariants(pageNumber:pageSize:queryItems:)
- updateSubscription(_:body:)
- validateLicense(licenseKey:instanceId:)