Payout

Represents a payout.

type Payout implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  status: PayoutStatusEnum!
  currency: String!
  name: String
  updated: DateTime!
  startDate: Date @deprecated
  created: String!
  endDate: String!
  tenant: Tenant!
  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 Globally Unique ID of this object

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

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

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

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

Payout.status ● PayoutStatusEnum! non-null enum

Status of the payout

Payout.currency ● String! non-null scalar

Currency code.

Payout.name ● String scalar

Payout name.

Payout.updated ● DateTime! non-null scalar

When the payout was last updated.

Payout.startDate ● Date deprecated scalar

DEPRECATED

This will be removed on July 16, 2025.

Start date of the payout period.

Payout.created ● String! non-null scalar

When the payout was created.

Payout.endDate ● String! non-null scalar

End date of the payout period.

Payout.tenant ● Tenant! non-null object

Tenant for this payout.

Payout.vendorPayouts ● VendorPayoutCountableConnection! non-null object

Vendor payouts in this payout.

Payout.vendorPayouts.before ● String scalar

Returns the items in the list that come before the specified cursor.

Payout.vendorPayouts.after ● String scalar

Returns the items in the list that come after the specified cursor.

Payout.vendorPayouts.first ● Int scalar

Returns the first n items from the list.

Payout.vendorPayouts.last ● Int scalar

Returns the items in the list that come after the specified cursor.

Payout.vendors ● Int! non-null scalar

Number of vendors included in this payout.

Payout.netSales ● Money! non-null object

Total net sales amount.

Payout.discounts ● Money! non-null object

Total discounts amount.

Payout.shipping ● Money! non-null object

Total shipping amount.

Payout.commission ● Money! non-null object

Total commission amount.

Payout.fees ● Money! non-null object

Total fees amount.

Payout.refunds ● Money! non-null object

Total refunds amount.

Payout.adjustments ● Money! non-null object

Total adjustments amount.

Payout.payout ● Money! non-null object

Total payout amount.

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Returned By

payout query

Member Of

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