--- displayed_sidebar: entitiesSidebar --- import ParameterTypes from "@site/src/components/ParameterTypes" # PaymentCollection ## Properties [`Currency`](Currency.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "symbol", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](PaymentSession.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`PaymentSession`](PaymentSession.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "cart", "type": "[`Cart`](Cart.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Cart`](Cart.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "billing_address", "type": "[`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer", "type": "[`Customer`](Customer.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "discount_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "discounts", "type": "[`Discount`](Discount.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "email", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](GiftCard.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "items", "type": "[`LineItem`](LineItem.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "object", "type": "``\"cart\"``", "description": "", "optional": false, "defaultValue": "`\"cart\"`", "children": [] }, { "name": "payment", "type": "[`Payment`](Payment.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](PaymentSession.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "region", "type": "[`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "region_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](SalesChannel.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "subtotal", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "type", "type": "[`CartType`](../enums/CartType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "afterLoad", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "cart_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_initiated", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_selected", "type": "``null`` \\| `boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "provider_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "status", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "payments", "type": "[`Payment`](Payment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Payment`](Payment.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "cart", "type": "[`Cart`](Cart.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Cart`](Cart.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "billing_address", "type": "[`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer", "type": "[`Customer`](Customer.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "discount_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "discounts", "type": "[`Discount`](Discount.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "email", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](GiftCard.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "items", "type": "[`LineItem`](LineItem.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "object", "type": "``\"cart\"``", "description": "", "optional": false, "defaultValue": "`\"cart\"`", "children": [] }, { "name": "payment", "type": "[`Payment`](Payment.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](PaymentSession.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "region", "type": "[`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "region_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](SalesChannel.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "subtotal", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "total", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "type", "type": "[`CartType`](../enums/CartType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "afterLoad", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "currency", "type": "[`Currency`](Currency.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Currency`](Currency.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "symbol", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order", "type": "[`Order`](Order.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Order`](Order.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "billing_address", "type": "[`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "cart", "type": "[`Cart`](Cart.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "cart_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "currency", "type": "[`Currency`](Currency.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "currency_code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer", "type": "[`Customer`](Customer.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "discount_total", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "discounts", "type": "[`Discount`](Discount.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "display_id", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](DraftOrder.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "edits", "type": "[`OrderEdit`](OrderEdit.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "email", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](Fulfillment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](GiftCard.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "items", "type": "[`LineItem`](LineItem.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "object", "type": "``\"order\"``", "description": "", "optional": false, "defaultValue": "`\"order\"`", "children": [] }, { "name": "paid_total", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payments", "type": "[`Payment`](Payment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "refunds", "type": "[`Refund`](Refund.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "region", "type": "[`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "region_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](LineItem.mdx)[]", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "returns", "type": "[`Return`](Return.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](SalesChannel.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address", "type": "[`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "status", "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "subtotal", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swaps", "type": "[`Swap`](Swap.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "total", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `Promise`<`void`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "provider_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swap", "type": "[`Swap`](Swap.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Swap`](Swap.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "additional_items", "type": "[`LineItem`](LineItem.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "cart", "type": "[`Cart`](Cart.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "cart_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "difference_due", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](Fulfillment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order", "type": "[`Order`](Order.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment", "type": "[`Payment`](Payment.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "return_order", "type": "[`Return`](Return.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address", "type": "[`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "region", "type": "[`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "automatic_taxes", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "countries", "type": "[`Country`](Country.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Country`](Country.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "display_name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "iso_2", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "iso_3", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "num_code", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "region", "type": "[`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "region_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "currency", "type": "[`Currency`](Currency.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Currency`](Currency.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "symbol", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "tax_code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](TaxProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`TaxProvider`](TaxProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "status", "type": "[`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "AUTHORIZED", "type": "``\"authorized\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "PARTIALLY_AUTHORIZED", "type": "``\"partially_authorized\"``", "description": "", "optional": true, "defaultValue": "", "children": [] } ] }, { "name": "type", "type": "[`ORDER_EDIT`](../enums/PaymentCollectionType.mdx#order_edit)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] } ]} />