ACHDetails
AcceptedPaymentMethods
Address
AfterpayDetails
ApplicationDetails
AppointmentSegment
Availability
BankAccount
BankAccountPaymentDetails
Booking
BookingCreatorDetails
Break
BreakType
BulkCreateCustomerData
BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute
BulkUpdateCustomerData
BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute
BusinessAppointmentSettings
BusinessBookingProfile
BusinessHours
BusinessHoursPeriod
BuyNowPayLaterDetails
Card
CardForgottenEventCard
CardPaymentDetails
CardPaymentTimeline
CashAppDetails
CashDrawerDevice
CashDrawerShift
CashDrawerShiftEvent
CashDrawerShiftSummary
CashPaymentDetails
CatalogAvailabilityPeriod
CatalogCategory
CatalogCustomAttributeDefinition
CatalogCustomAttributeDefinitionNumberConfig
CatalogCustomAttributeDefinitionSelectionConfig
CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection
CatalogCustomAttributeDefinitionStringConfig
CatalogCustomAttributeValue
CatalogDiscount
CatalogEcomSeoData
CatalogIdMapping
CatalogImage
CatalogInfoResponseLimits
CatalogItem
CatalogItemFoodAndBeverageDetails
CatalogItemFoodAndBeverageDetailsDietaryPreference
CatalogItemFoodAndBeverageDetailsIngredient
CatalogItemModifierListInfo
CatalogItemOption
CatalogItemOptionForItem
CatalogItemOptionValue
CatalogItemOptionValueForItemVariation
CatalogItemVariation
CatalogMeasurementUnit
CatalogModifier
CatalogModifierList
CatalogModifierOverride
CatalogObject
CatalogObjectBatch
CatalogObjectCategory
CatalogObjectReference
CatalogPricingRule
CatalogProductSet
CatalogQuery
CatalogQueryExact
CatalogQueryItemVariationsForItemOptionValues
CatalogQueryItemsForItemOptions
CatalogQueryItemsForModifierList
CatalogQueryItemsForTax
CatalogQueryPrefix
CatalogQueryRange
CatalogQuerySet
CatalogQuerySortedAttribute
CatalogQueryText
CatalogQuickAmount
CatalogQuickAmountsSettings
CatalogStockConversion
CatalogSubscriptionPlan
CatalogSubscriptionPlanVariation
CatalogTax
CatalogTimePeriod
CatalogV1Id
CatalogVersionUpdatedEventCatalogVersion
CategoryPathToRootNode
Checkout
CheckoutLocationSettings
CheckoutLocationSettingsBranding
CheckoutLocationSettingsCoupons
CheckoutLocationSettingsPolicy
CheckoutLocationSettingsTipping
CheckoutMerchantSettings
CheckoutMerchantSettingsPaymentMethods
CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay
CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange
CheckoutMerchantSettingsPaymentMethodsPaymentMethod
CheckoutOptions
ClearpayDetails
CollectedData
Component
ConfirmationDecision
ConfirmationOptions
Coordinates
CustomAttribute
CustomAttributeDefinition
CustomAttributeDefinitionEventDataObject
CustomAttributeEventDataObject
CustomAttributeFilter
CustomField
Customer
CustomerAddressFilter
CustomerCreatedEventEventContext
CustomerCreatedEventEventContextMerge
CustomerCreationSourceFilter
CustomerCustomAttributeFilter
CustomerCustomAttributeFilterValue
CustomerCustomAttributeFilters
CustomerDeletedEventEventContext
CustomerDeletedEventEventContextMerge
CustomerDetails
CustomerFilter
CustomerGroup
CustomerPreferences
CustomerQuery
CustomerSegment
CustomerSort
CustomerTaxIds
CustomerTextFilter
DataCollectionOptions
DateRange
Destination
DestinationDetails
DestinationDetailsCardRefundDetails
DestinationDetailsCashRefundDetails
DestinationDetailsExternalRefundDetails
Device
DeviceAttributes
DeviceCheckoutOptions
DeviceCode
DeviceComponentDetails
DeviceComponentDetailsApplicationDetails
DeviceComponentDetailsBatteryDetails
DeviceComponentDetailsCardReaderDetails
DeviceComponentDetailsEthernetDetails
DeviceComponentDetailsMeasurement
DeviceComponentDetailsNetworkInterfaceDetails
DeviceComponentDetailsWiFiDetails
DeviceDetails
DeviceMetadata
DeviceStatus
DigitalWalletDetails
Dispute
DisputeEvidence
DisputeEvidenceFile
DisputedPayment
Error
Event
EventMetadata
EventTypeMetadata
ExternalPaymentDetails
FilterValue
FloatNumberRange
Fulfillment
FulfillmentDeliveryDetails
FulfillmentFulfillmentEntry
FulfillmentPickupDetails
FulfillmentPickupDetailsCurbsidePickupDetails
FulfillmentRecipient
FulfillmentShipmentDetails
GiftCard
GiftCardActivity
GiftCardActivityActivate
GiftCardActivityAdjustDecrement
GiftCardActivityAdjustIncrement
GiftCardActivityBlock
GiftCardActivityClearBalance
GiftCardActivityDeactivate
GiftCardActivityImport
GiftCardActivityImportReversal
GiftCardActivityLoad
GiftCardActivityRedeem
GiftCardActivityRefund
GiftCardActivityTransferBalanceFrom
GiftCardActivityTransferBalanceTo
GiftCardActivityUnblock
GiftCardActivityUnlinkedActivityRefund
InventoryAdjustment
InventoryAdjustmentGroup
InventoryChange
InventoryCount
InventoryPhysicalCount
InventoryTransfer
Invoice
InvoiceAcceptedPaymentMethods
InvoiceAttachment
InvoiceCustomField
InvoiceFilter
InvoicePaymentReminder
InvoiceQuery
InvoiceRecipient
InvoiceRecipientTaxIds
InvoiceSort
ItemVariationLocationOverrides
Job
JobAssignment
Location
LocationBookingProfile
LoyaltyAccount
LoyaltyAccountExpiringPointDeadline
LoyaltyAccountMapping
LoyaltyEvent
LoyaltyEventAccumulatePoints
LoyaltyEventAccumulatePromotionPoints
LoyaltyEventAdjustPoints
LoyaltyEventCreateReward
LoyaltyEventDateTimeFilter
LoyaltyEventDeleteReward
LoyaltyEventExpirePoints
LoyaltyEventFilter
LoyaltyEventLocationFilter
LoyaltyEventLoyaltyAccountFilter
LoyaltyEventOrderFilter
LoyaltyEventOther
LoyaltyEventQuery
LoyaltyEventRedeemReward
LoyaltyEventTypeFilter
LoyaltyProgram
LoyaltyProgramAccrualRule
LoyaltyProgramAccrualRuleCategoryData
LoyaltyProgramAccrualRuleItemVariationData
LoyaltyProgramAccrualRuleSpendData
LoyaltyProgramAccrualRuleVisitData
LoyaltyProgramExpirationPolicy
LoyaltyProgramRewardTier
LoyaltyProgramTerminology
LoyaltyPromotion
LoyaltyPromotionAvailableTimeData
LoyaltyPromotionIncentive
LoyaltyPromotionIncentivePointsAdditionData
LoyaltyPromotionIncentivePointsMultiplierData
LoyaltyPromotionTriggerLimit
LoyaltyReward
MeasurementUnit
MeasurementUnitCustom
Merchant
ModifierLocationOverrides
Money
OauthAuthorizationRevokedEventRevocationObject
OfflinePaymentDetails
Order
OrderCreated
OrderCreatedObject
OrderEntry
OrderFulfillment
OrderFulfillmentDeliveryDetails
OrderFulfillmentFulfillmentEntry
OrderFulfillmentPickupDetails
OrderFulfillmentPickupDetailsCurbsidePickupDetails
OrderFulfillmentRecipient
OrderFulfillmentShipmentDetails
OrderFulfillmentUpdated
OrderFulfillmentUpdatedObject
OrderFulfillmentUpdatedUpdate
OrderLineItem
OrderLineItemAppliedDiscount
OrderLineItemAppliedServiceCharge
OrderLineItemAppliedTax
OrderLineItemDiscount
OrderLineItemModifier
OrderLineItemPricingBlocklists
OrderLineItemPricingBlocklistsBlockedDiscount
OrderLineItemPricingBlocklistsBlockedTax
OrderLineItemTax
OrderMoneyAmounts
OrderPricingOptions
OrderQuantityUnit
OrderReturn
OrderReturnDiscount
OrderReturnLineItem
OrderReturnLineItemModifier
OrderReturnServiceCharge
OrderReturnTax
OrderReturnTip
OrderReward
OrderRoundingAdjustment
OrderServiceCharge
OrderSource
OrderUpdated
OrderUpdatedObject
PaginationCursor
Payment
PaymentBalanceActivityAppFeeRefundDetail
PaymentBalanceActivityAppFeeRevenueDetail
PaymentBalanceActivityAutomaticSavingsDetail
PaymentBalanceActivityAutomaticSavingsReversedDetail
PaymentBalanceActivityChargeDetail
PaymentBalanceActivityDepositFeeDetail
PaymentBalanceActivityDepositFeeReversedDetail
PaymentBalanceActivityDisputeDetail
PaymentBalanceActivityFeeDetail
PaymentBalanceActivityFreeProcessingDetail
PaymentBalanceActivityHoldAdjustmentDetail
PaymentBalanceActivityOpenDisputeDetail
PaymentBalanceActivityOtherAdjustmentDetail
PaymentBalanceActivityOtherDetail
PaymentBalanceActivityRefundDetail
PaymentBalanceActivityReleaseAdjustmentDetail
PaymentBalanceActivityReserveHoldDetail
PaymentBalanceActivityReserveReleaseDetail
PaymentBalanceActivitySquareCapitalPaymentDetail
PaymentBalanceActivitySquareCapitalReversedPaymentDetail
PaymentBalanceActivitySquarePayrollTransferDetail
PaymentBalanceActivitySquarePayrollTransferReversedDetail
PaymentBalanceActivityTaxOnFeeDetail
PaymentBalanceActivityThirdPartyFeeDetail
PaymentBalanceActivityThirdPartyFeeRefundDetail
PaymentLink
PaymentLinkRelatedResources
PaymentOptions
PaymentRefund
Payout
PayoutEntry
PayoutFee
Phase
PhaseInput
PrePopulatedData
ProcessingFee
QrCodeOptions
QuantityRatio
QuickPay
Range
ReceiptOptions
Refund
RiskEvaluation
SaveCardOptions
SearchAvailabilityFilter
SearchAvailabilityQuery
SearchEventsFilter
SearchEventsQuery
SearchEventsSort
SearchLoyaltyAccountsRequestLoyaltyAccountQuery
SearchLoyaltyRewardsRequestLoyaltyRewardQuery
SearchOrdersCustomerFilter
SearchOrdersDateTimeFilter
SearchOrdersFilter
SearchOrdersFulfillmentFilter
SearchOrdersQuery
SearchOrdersSort
SearchOrdersSourceFilter
SearchOrdersStateFilter
SearchSubscriptionsFilter
SearchSubscriptionsQuery
SearchTeamMembersFilter
SearchTeamMembersQuery
SearchVendorsRequestFilter
SearchVendorsRequestSort
SegmentFilter
SelectOption
SelectOptions
Shift
ShiftFilter
ShiftQuery
ShiftSort
ShiftWage
ShiftWorkday
ShippingFee
SignatureImage
SignatureOptions
Site
Snippet
SourceApplication
SquareAccountDetails
StandardUnitDescription
StandardUnitDescriptionGroup
Subscription
SubscriptionAction
SubscriptionEvent
SubscriptionEventInfo
SubscriptionPhase
SubscriptionPricing
SubscriptionSource
SubscriptionTestResult
TaxIds
TeamMember
TeamMemberAssignedLocations
TeamMemberBookingProfile
TeamMemberWage
Tender
TenderBankAccountDetails
TenderBuyNowPayLaterDetails
TenderCardDetails
TenderCashDetails
TenderSquareAccountDetails
TerminalAction
TerminalActionQuery
TerminalActionQueryFilter
TerminalActionQuerySort
TerminalCheckout
TerminalCheckoutQuery
TerminalCheckoutQueryFilter
TerminalCheckoutQuerySort
TerminalRefund
TerminalRefundQuery
TerminalRefundQueryFilter
TerminalRefundQuerySort
TimeRange
TipSettings
Vendor
VendorContact
WageSetting
WebhookSubscription
WorkweekConfig
<- Object
Object
API version
2024-12-18
All versions ->
Represents details about a CLEAR_BALANCE gift card activity type.
CLEAR_BALANCE
reason
string
Required
The reason the gift card balance was cleared.
Show values