Square API

Objects & Enums

AcceptedPaymentMethods

ACHDetails

ACH-specific details about BANK_ACCOUNT type payments with the transfer_type of ACH.

AdditionalRecipient

Represents an additional recipient other than the merchant receiving a portion of this tender.

Address

Represents a postal address in a country.

AfterpayDetails

Additional details about Afterpay payments.

ApplicationDetails

Details about the application that took the payment.

AppointmentSegment

Defines an appointment segment of a booking.

Availability

Defines an appointment slot that encapsulates the appointment segments, location and starting time available for booking.

BankAccount

Represents a bank account.

BankAccountCreatedWebhookData

BankAccountCreatedWebhookObject

BankAccountDisabledWebhookData

BankAccountDisabledWebhookObject

BankAccountPaymentDetails

Additional details about BANK_ACCOUNT type payments.

BankAccountVerifiedWebhookData

BankAccountVerifiedWebhookObject

Booking

Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service at a given location to a requesting customer in one or more appointment segments.

BookingCreatedWebhookData

BookingCreatedWebhookObject

BookingCreatorDetails

Information about a booking creator.

BookingUpdatedWebhookData

BookingUpdatedWebhookObject

Break

A record of an employee's break during a shift.

BreakType

A defined break template that sets an expectation for possible Break instances on a Shift.

BusinessAppointmentSettings

The service appointment settings, including where and how the service is provided.

BusinessBookingProfile

BusinessHours

The hours of operation for a location.

BusinessHoursPeriod

Represents a period of time during which a business location is open.

BuyNowPayLaterDetails

Additional details about a Buy Now Pay Later payment type.

Card

Represents the payment details of a card to be used for payments.

CardAutomaticallyUpdatedWebhookData

CardAutomaticallyUpdatedWebhookObject

CardCreatedWebhookData

CardCreatedWebhookObject

CardDisabledWebhookData

CardDisabledWebhookObject

CardForgottenWebhookCard

CardForgottenWebhookData

CardForgottenWebhookObject

CardPaymentDetails

Reflects the current status of a card payment.

CardPaymentTimeline

The timeline for card payments.

CardUpdatedWebhookData

CardUpdatedWebhookObject

CashAppDetails

Additional details about WALLET type payments with the brand of CASH_APP.

CashDrawerDevice

CashDrawerShift

This model gives the details of a cash drawer shift.

CashDrawerShiftEvent

CashDrawerShiftSummary

The summary of a closed cash drawer shift.

CashPaymentDetails

Stores details about a cash payment.

CatalogCategory

A category to which a CatalogItem instance belongs.

CatalogDiscount

A discount applicable to items.

CatalogIdMapping

A mapping between a temporary client-supplied ID and a permanent server-generated ID.

CatalogImage

An image file to use in Square catalogs.

CatalogInfoResponseLimits

CatalogItem

A CatalogObject instance of the ITEM type, also referred to as an item, in the catalog.

CatalogItemModifierListInfo

Options to control the properties of a CatalogModifierList applied to a CatalogItem instance.

CatalogItemVariation

An item variation, representing a product for sale, in the Catalog object model.

CatalogMeasurementUnit

Represents the unit used to measure a CatalogItemVariation and specifies the precision for decimal quantities.

CatalogModifier

A modifier applicable to items at the time of sale.

CatalogModifierList

A list of modifiers applicable to items at the time of sale.

CatalogModifierOverride

Options to control how to override the default behavior of the specified modifier.

CatalogObject

The wrapper object for the catalog entries of a given object type.

CatalogObjectBatch

A batch of catalog objects.

CatalogPricingRule

Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period.

CatalogProductSet

Represents a collection of catalog objects for the purpose of applying a PricingRule.

CatalogQuery

A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the SearchCatalogObjects endpoint.

CatalogQueryExact

The query filter to return the search result by exact match of the specified attribute name and value.

CatalogQueryItemsForModifierList

The query filter to return the items containing the specified modifier list IDs.

CatalogQueryItemsForTax

The query filter to return the items containing the specified tax IDs.

CatalogQueryPrefix

The query filter to return the search result whose named attribute values are prefixed by the specified attribute value.

CatalogQueryRange

The query filter to return the search result whose named attribute values fall between the specified range.

CatalogQuerySet

The query filter to return the search results by exact match of the specified attribute_name and any of the attribute_values.

CatalogQuerySortedAttribute

The query expression to specify the key to sort search results.

CatalogQueryText

The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case.

CatalogSubscriptionPlan

Describes a subscription plan.

CatalogTax

A tax applicable to an item.

CatalogTimePeriod

Represents a time period - either a single period or a repeating period.

CatalogV1Id

A Square API V1 identifier of an item, including the object ID and its associated location ID.

CatalogVersionUpdatedWebhookCatalogVersion

CatalogVersionUpdatedWebhookData

CatalogVersionUpdatedWebhookObject

ChargeRequestAdditionalRecipient

Represents an additional recipient other than the merchant entitled to a portion of the tender.

Checkout

Square Checkout lets merchants accept online payments for supported payment types using a checkout workflow hosted on squareup.com.

CheckoutOptions

Coordinates

Latitude and longitude coordinates.

CustomAttributeFilter

Supported custom attribute query expressions for calling the SearchCatalogItems endpoint to search for items or item variations.

Customer

Represents a Square customer profile in the Customer Directory of a Square seller.

CustomerCreatedWebhookData

The data associated with the webhook event.

CustomerCreatedWebhookEventContext

Information about the change that triggered the event.

CustomerCreatedWebhookEventContextMerge

Information about a merge operation, which creates a new customer using aggregated properties from two or more existing customers.

CustomerCreatedWebhookObject

An object that contains the customer associated with the webhook event.

CustomerCreationSourceFilter

The creation source filter.

CustomerDeletedWebhookData

The data associated with the webhook event.

CustomerDeletedWebhookEventContext

Information about the change that triggered the event.

CustomerDeletedWebhookEventContextMerge

Information about a merge operation, which creates a new customer using aggregated properties from two or more existing customers.

CustomerDeletedWebhookObject

An object that contains the customer associated with the webhook event.

CustomerFilter

Represents a set of CustomerQuery filters used to limit the set of customers returned by the SearchCustomers endpoint.

CustomerGroup

Represents a group of customer profiles.

CustomerPreferences

Represents communication preferences for the customer profile.

CustomerQuery

Represents a query including filtering criteria, sorting criteria, or both used to search for customer profiles.

CustomerSegment

Represents a group of customer profiles that match one or more predefined filter criteria.

CustomerSort

Specifies how searched customers profiles are sorted, including the sort key and sort order.

CustomerTaxIds

Represents the tax ID associated with a customer profile.

CustomerTextFilter

A filter to select customers based on exact or fuzzy matching of customer attributes against a specified query.

CustomerUpdatedWebhookData

The data associated with the webhook event.

CustomerUpdatedWebhookObject

An object that contains the customer associated with the webhook event.

CustomField

Describes a custom form field to add to the checkout page to collect more information from buyers during checkout.

DateRange

A range defined by two dates.

Destination

Information about the destination against which the payout was made.

Device

DeviceCheckoutOptions

DeviceCode

DeviceCodePairedWebhookData

DeviceCodePairedWebhookObject

DeviceDetails

Details about the device that took the payment.

DigitalWalletDetails

Additional details about WALLET type payments.

Dispute

Represents a dispute a cardholder initiated with their bank.

DisputeCreatedWebhookData

DisputeCreatedWebhookObject

DisputedPayment

The payment the cardholder disputed.

DisputeEvidence

DisputeEvidenceAddedWebhookData

DisputeEvidenceAddedWebhookObject

DisputeEvidenceCreatedWebhookData

DisputeEvidenceCreatedWebhookObject

DisputeEvidenceDeletedWebhookData

DisputeEvidenceDeletedWebhookObject

DisputeEvidenceFile

A file to be uploaded as dispute evidence.

DisputeEvidenceRemovedWebhookData

DisputeEvidenceRemovedWebhookObject

DisputeStateChangedWebhookData

DisputeStateChangedWebhookObject

DisputeStateUpdatedWebhookData

DisputeStateUpdatedWebhookObject

Employee

An employee object that is used by the external API.

EmployeeWage

The hourly wage rate that an employee earns on a Shift for doing the job specified by the title property of this object.

Error

Represents an error encountered during a request to the Connect API.

ExternalPaymentDetails

Stores details about an external payment.

GiftCard

Represents a Square gift card.

GiftCardActivity

Represents an action performed on a gift card that affects its state or balance.

GiftCardActivityActivate

Represents details about an ACTIVATE gift card activity type.

GiftCardActivityAdjustDecrement

Represents details about an ADJUST_DECREMENT gift card activity type.

GiftCardActivityAdjustIncrement

Represents details about an ADJUST_INCREMENT gift card activity type.

GiftCardActivityBlock

Represents details about a BLOCK gift card activity type.

GiftCardActivityClearBalance

Represents details about a CLEAR_BALANCE gift card activity type.

GiftCardActivityCreatedWebhookData

Represents the data associated with a gift_card.activity.created webhook event.

GiftCardActivityCreatedWebhookObject

An object that contains the gift card activity associated with a gift_card.activity.created webhook event.

GiftCardActivityDeactivate

Represents details about a DEACTIVATE gift card activity type.

GiftCardActivityImport

Represents details about an IMPORT gift card activity type.

GiftCardActivityImportReversal

Represents details about an IMPORT_REVERSAL gift card activity type.

GiftCardActivityLoad

Represents details about a LOAD gift card activity type.

GiftCardActivityRedeem

Represents details about a REDEEM gift card activity type.

GiftCardActivityRefund

Represents details about a REFUND gift card activity type.

GiftCardActivityUnblock

Represents details about an UNBLOCK gift card activity type.

GiftCardActivityUnlinkedActivityRefund

Represents details about an UNLINKED_ACTIVITY_REFUND gift card activity type.

GiftCardActivityUpdatedWebhookData

The data associated with a gift_card.activity.updated webhook event.

GiftCardActivityUpdatedWebhookObject

An object that contains the gift card activity associated with a gift_card.activity.updated webhook event.

GiftCardCreatedWebhookData

The data associated with a gift_card.created webhook event.

GiftCardCreatedWebhookObject

An object that contains the gift card associated with a gift_card.created webhook event.

GiftCardCustomerLinkedWebhookData

The data associated with a gift_card.customer_linked webhook event.

GiftCardCustomerLinkedWebhookObject

An object that contains the gift card and customer ID associated with a gift_card.customer_linked webhook event.

GiftCardCustomerUnlinkedWebhookData

The data associated with a gift_card.customer_unlinked webhook event.

GiftCardCustomerUnlinkedWebhookObject

An object that contains the gift card and the customer ID associated with a gift_card.customer_linked webhook event.

GiftCardUpdatedWebhookData

The data associated with a gift_card.updated webhook event.

GiftCardUpdatedWebhookObject

An object that contains the gift card associated with a gift_card.updated webhook event.

InventoryAdjustment

Represents a change in state or quantity of product inventory at a particular time and location.

InventoryChange

Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular CatalogObject instance.

InventoryCount

Represents Square-estimated quantity of items in a particular state at a particular seller location based on the known history of physical counts and inventory adjustments.

InventoryCountUpdatedWebhookData

InventoryCountUpdatedWebhookObject

InventoryPhysicalCount

Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller's employee.

InventoryTransfer

Represents the transfer of a quantity of product inventory at a particular time from one location to another.

Invoice

Stores information about an invoice.

InvoiceAcceptedPaymentMethods

The payment methods that customers can use to pay an invoice on the Square-hosted invoice page.

InvoiceCanceledWebhookData

InvoiceCanceledWebhookObject

InvoiceCreatedWebhookData

InvoiceCreatedWebhookObject

InvoiceCustomField

An additional seller-defined and customer-facing field to include on the invoice.

InvoiceDeletedWebhookData

InvoiceFilter

Describes query filters to apply.

InvoicePaymentMadeWebhookData

InvoicePaymentMadeWebhookObject

InvoicePaymentReminder

Describes a payment request reminder automatic notification that Square sends to the customer.

InvoicePublishedWebhookData

InvoicePublishedWebhookObject

InvoiceQuery

Describes query criteria for searching invoices.

InvoiceRecipient

Represents a snapshot of customer data.

InvoiceRecipientTaxIds

Represents the tax IDs for an invoice recipient.

InvoiceRefundedWebhookData

InvoiceRefundedWebhookObject

InvoiceScheduledChargeFailedWebhookData

InvoiceScheduledChargeFailedWebhookObject

InvoiceSort

Identifies the sort field and sort order.

InvoiceUpdatedWebhookData

InvoiceUpdatedWebhookObject

ItemVariationLocationOverrides

Price and inventory alerting overrides for a CatalogItemVariation at a specific Location.

JobAssignment

An object describing a job that a team member is assigned to.

LaborShiftCreatedWebhookData

LaborShiftCreatedWebhookObject

LaborShiftDeletedWebhookData

LaborShiftUpdatedWebhookData

LaborShiftUpdatedWebhookObject

Location

Represents one of a business' locations.

LoyaltyAccount

Describes a loyalty account in a loyalty program.

LoyaltyAccountCreatedWebhookData

LoyaltyAccountDeletedWebhookData

LoyaltyAccountExpiringPointDeadline

Represents a set of points for a loyalty account that are scheduled to expire on a specific date.

LoyaltyAccountMapping

Represents the mapping that associates a loyalty account with a buyer.

LoyaltyAccountUpdatedWebhookData

LoyaltyEvent

Provides information about a loyalty event.

LoyaltyEventAccumulatePoints

Provides metadata when the event type is ACCUMULATE_POINTS.

LoyaltyEventAdjustPoints

Provides metadata when the event type is ADJUST_POINTS.

LoyaltyEventCreatedWebhookData

LoyaltyEventCreateReward

Provides metadata when the event type is CREATE_REWARD.

LoyaltyEventDateTimeFilter

Filter events by date time range.

LoyaltyEventDeleteReward

Provides metadata when the event type is DELETE_REWARD.

LoyaltyEventExpirePoints

Provides metadata when the event type is EXPIRE_POINTS.

LoyaltyEventFilter

The filtering criteria.

LoyaltyEventLocationFilter

Filter events by location.

LoyaltyEventLoyaltyAccountFilter

Filter events by loyalty account.

LoyaltyEventOrderFilter

Filter events by the order associated with the event.

LoyaltyEventOther

Provides metadata when the event type is OTHER.

LoyaltyEventQuery

Represents a query used to search for loyalty events.

LoyaltyEventRedeemReward

Provides metadata when the event type is REDEEM_REWARD.

LoyaltyEventTypeFilter

Filter events by event type.

LoyaltyProgram

Represents a Square loyalty program.

LoyaltyProgramAccrualRule

Defines an accrual rule, which is how buyers can earn points.

LoyaltyProgramAccrualRuleCategoryData

Represents additional data for rules with the CATEGORY accrual type.

LoyaltyProgramAccrualRuleItemVariationData

Represents additional data for rules with the ITEM_VARIATION accrual type.

LoyaltyProgramAccrualRuleSpendData

Represents additional data for rules with the SPEND accrual type.

LoyaltyProgramAccrualRuleVisitData

Represents additional data for rules with the VISIT accrual type.

LoyaltyProgramCreatedWebhookData

LoyaltyProgramCreatedWebhookObject

An object that contains the loyalty program.

LoyaltyProgramExpirationPolicy

Describes when the loyalty program expires.

LoyaltyProgramRewardDefinition

Provides details about the reward tier discount.

LoyaltyProgramRewardTier

Represents a reward tier in a loyalty program.

LoyaltyProgramTerminology

Represents the naming used for loyalty points.

LoyaltyProgramUpdatedWebhookData

LoyaltyReward

Represents a contract to redeem loyalty points for a reward tier discount.

MeasurementUnit

Represents a unit of measurement to use with a quantity, such as ounces or inches.

MeasurementUnitCustom

The information needed to define a custom unit, provided by the seller.

Merchant

Represents a business that sells with Square.

Money

Represents an amount of money.

Order

Contains all information related to a single order to process with Square, including line items that specify the products to purchase.

OrderEntry

A lightweight description of an order that is returned when returned_entries is true on a SearchOrdersRequest.

OrderFulfillment

Contains details about how to fulfill this order.

OrderFulfillmentPickupDetails

Contains details necessary to fulfill a pickup order.

OrderFulfillmentRecipient

Contains information about the recipient of a fulfillment.

OrderLineItem

Represents a line item in an order.

OrderLineItemDiscount

Represents a discount that applies to one or more line items in an order.

OrderLineItemModifier

A CatalogModifier.

OrderLineItemTax

Represents a tax that applies to one or more line item in the order.

OrderPricingOptions

Pricing options for an order.

OrderQuantityUnit

Contains the measurement unit for a quantity and a precision that specifies the number of digits after the decimal point for decimal quantities.

OrderReturnServiceCharge

Represents the service charge applied to the original order.

OrderServiceCharge

Represents a service charge applied to an order.

OrderSource

Represents the origination details of an order.

Payment

Represents a payment processed by the Square API.

PaymentBalanceActivityAutomaticSavingsDetail

PaymentBalanceActivityAutomaticSavingsReversedDetail

PaymentBalanceActivityChargeDetail

DESCRIPTION OF PaymentBalanceActivityChargeDetail

PaymentBalanceActivityDepositFeeDetail

PaymentBalanceActivityDisputeDetail

PaymentBalanceActivityFeeDetail

PaymentBalanceActivityFreeProcessingDetail

PaymentBalanceActivityHoldAdjustmentDetail

PaymentBalanceActivityOpenDisputeDetail

PaymentBalanceActivityOtherAdjustmentDetail

PaymentBalanceActivityOtherDetail

PaymentBalanceActivityRefundDetail

PaymentBalanceActivityReleaseAdjustmentDetail

PaymentBalanceActivityReserveHoldDetail

PaymentBalanceActivityReserveReleaseDetail

PaymentBalanceActivitySquareCapitalPaymentDetail

PaymentBalanceActivitySquareCapitalReversedPaymentDetail

PaymentBalanceActivityTaxOnFeeDetail

PaymentBalanceActivityThirdPartyFeeDetail

PaymentBalanceActivityThirdPartyFeeRefundDetail

PaymentCreatedWebhookData

PaymentCreatedWebhookObject

PaymentLink

PaymentRefund

Represents a refund of a payment made using Square.

PaymentUpdatedWebhookData

PaymentUpdatedWebhookObject

Payout

An accounting of the amount owed the seller and record of the actual transfer to their external bank account or to the Square balance.

PayoutEntry

One or more PayoutEntries that make up a Payout.

PayoutFailedWebhookData

PayoutFailedWebhookObject

PayoutFee

Represents a payout fee that can incur as part of a payout.

PayoutPaidWebhookData

PayoutPaidWebhookObject

PayoutSentWebhookData

PayoutSentWebhookObject

PrePopulatedData

Describes buyer data to prepopulate in the payment form.

ProcessingFee

Represents the Square processing fee.

QuickPay

Describes an ad hoc item and price to generate a quick pay checkout link.

Range

The range of a number value between the specified lower and upper bounds.

Refund

Represents a refund processed for a Square transaction.

RefundCreatedWebhookData

RefundCreatedWebhookObject

RefundUpdatedWebhookData

RefundUpdatedWebhookObject

SearchAvailabilityFilter

A query filter to search for buyer-accessible availabilities by.

SearchAvailabilityQuery

The query used to search for buyer-accessible availabilities of bookings.

SearchLoyaltyAccountsRequestLoyaltyAccountQuery

The search criteria for the loyalty accounts.

SearchLoyaltyRewardsRequestLoyaltyRewardQuery

The set of search requirements.

SearchOrdersDateTimeFilter

Filter for Order objects based on whether their CREATED_AT, CLOSED_AT, or UPDATED_AT timestamps fall within a specified time range.

SearchOrdersFilter

Filtering criteria to use for a SearchOrders request.

SearchOrdersFulfillmentFilter

Filter based on order fulfillment information.

SearchOrdersQuery

Contains query criteria for the search.

SearchOrdersSort

Sorting criteria for a SearchOrders request.

SearchOrdersSourceFilter

A filter based on order source information.

SearchOrdersStateFilter

Filter by the current order state.

SearchSubscriptionsFilter

Represents a set of query expressions filters to narrow the scope of targeted subscriptions returned by the SearchSubscriptions endpoint.

SearchSubscriptionsQuery

Represents a query, consisting of specified query expressions, used to search for subscriptions.

SearchTeamMembersFilter

Represents a filter used in a search for TeamMember objects.

SearchTeamMembersQuery

Represents the parameters in a search for TeamMember objects.

SegmentFilter

A query filter to search for buyer-accessible appointment segments by.

Shift

A record of the hourly rate, start, and end times for a single work shift for an employee.

ShiftFilter

Defines a filter used in a search for Shift records.

ShiftQuery

The parameters of a Shift search query, which includes filter and sort options.

ShiftSort

Sets the sort order of search results.

ShiftWage

The hourly wage rate used to compensate an employee for this shift.

ShiftWorkday

A Shift search query filter parameter that sets a range of days that a Shift must start or end in before passing the filter condition.

Site

Represents a Square Online site, which is an online store for a Square seller.

Snippet

Represents the snippet that is added to a Square Online site.

SourceApplication

Represents information about the application used to generate a change.

StandardUnitDescription

Contains the name and abbreviation for standard measurement unit.

StandardUnitDescriptionGroup

Group of standard measurement units.

Subscription

Represents a subscription to a subscription plan by a subscriber.

SubscriptionCreatedWebhookData

SubscriptionCreatedWebhookObject

SubscriptionEvent

Describes changes to a subscription and the subscription status.

SubscriptionEventInfo

Provides information about the subscription event.

SubscriptionPhase

Describes a phase in a subscription plan.

SubscriptionUpdatedWebhookData

SubscriptionUpdatedWebhookObject

TeamMember

A record representing an individual team member for a business.

TeamMemberAssignedLocations

An object that represents a team member's assignment to locations.

TeamMemberBookingProfile

The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider.

TeamMemberCreatedWebhookData

TeamMemberCreatedWebhookObject

TeamMemberUpdatedWebhookData

TeamMemberUpdatedWebhookObject

TeamMemberWage

The hourly wage rate that a team member earns on a Shift for doing the job specified by the title property of this object.

TeamMemberWageSettingUpdatedWebhookData

TeamMemberWageSettingUpdatedWebhookObject

Tender

Represents a tender i.e., a method of payment used in a Square transaction.

TenderCardDetails

Represents additional details of a tender with type CARD or SQUARE_GIFT_CARD

TenderCashDetails

Represents the details of a tender with type CASH.

TerminalCheckout

Represents a checkout processed by the Square Terminal.

TerminalCheckoutCreatedWebhookData

TerminalCheckoutCreatedWebhookObject

TerminalCheckoutQuery

TerminalCheckoutQueryFilter

TerminalCheckoutQuerySort

TerminalCheckoutUpdatedWebhookData

TerminalCheckoutUpdatedWebhookObject

TerminalRefund

Represents a payment refund processed by the Square Terminal.

TerminalRefundCreatedWebhookData

TerminalRefundCreatedWebhookObject

TerminalRefundQuery

TerminalRefundQueryFilter

TerminalRefundQuerySort

TerminalRefundUpdatedWebhookData

TerminalRefundUpdatedWebhookObject

TimeRange

Represents a generic time range.

TipSettings

Transaction

Represents a transaction processed with Square, either with the Connect API or with Square Point of Sale.

WageSetting

An object representing a team member's wage information.

Webhook

WebhookData

WorkweekConfig

Sets the day of the week and hour of the day that a business starts a workweek.