Payout

No description

type Payout implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  metadata: [MetadataItem!]!
  tenant: Tenant!
  created: String!
  updated: DateTime!
  startDate: Date @deprecated
  endDate: String!
  status: PayoutStatusEnum!
  name: String
  currency: String!
  vendorPayouts(
    before: String
    after: String
    first: Int
    last: Int
  ): VendorPayoutCountableConnection
  vendors: Int!
  netSales: Money!
  discounts: Money!
  shipping: Money!
  commission: Money!
  fees: Money!
  refunds: Money!
  adjustments: Money!
  payout: Money!
}

Show more ↓

Fields

Payout.id ● ID! non-null scalar

The ID of the object

Payout.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items.Requires proper staff permissions to access.

Payout.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Payout.tenant ● Tenant! non-null object

Payout.created ● String! non-null scalar

Payout.updated ● DateTime! non-null scalar

Payout.startDate ● Date deprecated scalar

DEPRECATED

This will be removed on July 16, 2025.

Payout.endDate ● String! non-null scalar

Payout.status ● PayoutStatusEnum! non-null enum

Status of the payout

Payout.name ● String scalar

Payout.currency ● String! non-null scalar

Payout.vendorPayouts ● VendorPayoutCountableConnection object

Vendor payouts included in this payout period

Payout.vendorPayouts.before ● String scalar

Return the elements in the list that come before the specified cursor.

Payout.vendorPayouts.after ● String scalar

Return the elements in the list that come after the specified cursor.

Payout.vendorPayouts.first ● Int scalar

Return the first n elements from the list.

Payout.vendorPayouts.last ● Int scalar

Return the last n elements from the list.

Payout.vendors ● Int! non-null scalar

Payout.netSales ● Money! non-null object

Payout.discounts ● Money! non-null object

Payout.shipping ● Money! non-null object

Payout.commission ● Money! non-null object

Payout.fees ● Money! non-null object

Payout.refunds ● Money! non-null object

Payout.adjustments ● Money! non-null object

Payout.payout ● Money! non-null object

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned By

payout query

Member Of

PayoutCountableEdge object ● PayoutCreate object ● PayoutCreateAsync object ● PayoutDelete object ● PayoutProcess object ● PayoutStatusUpdate object ● PayoutUpdate object ● VendorPayout object