Module models

Source
Expand description

Model structs

Modules§

enums
Enums live here
errors
Error model structs

Structs§

AchDetails
ACH-specific details about BANK_ACCOUNT type payments with the transfer_type of ACH.
AdditionalRecipientDeprecated
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.
BankAccountPaymentDetails
Additional details about BANK_ACCOUNT type payments.
BatchChangeInventoryRequest
This is a model class for BatchChangeInventoryRequest type.
BatchChangeInventoryResponse
This is a model struct for BatchChangeInventoryResponse type.
BatchDeleteCatalogObjectsRequest
This is a model class for BatchDeleteCatalogObjectsRequest type.
BatchDeleteCatalogObjectsResponse
This is a model struct for BatchDeleteCatalogObjectsResponse type.
BatchRetrieveCatalogObjectsRequest
This is a model class for BatchRetrieveCatalogObjectsRequest type.
BatchRetrieveCatalogObjectsResponse
This is a model struct for BatchRetrieveCatalogObjectsResponse type.
BatchRetrieveInventoryChangesRequest
This is a model struct for BatchRetrieveInventoryChangesRequest type.
BatchRetrieveInventoryChangesResponse
This is a model struct for BatchRetrieveInventoryChangesResponse type.
BatchRetrieveInventoryCountsRequest
This is a model struct for BatchRetrieveInventoryCountsRequest type.
BatchRetrieveInventoryCountsResponse
This is a model struct for BatchRetrieveInventoryCountsResponse type.
BatchRetrieveOrdersRequest
This is a model class for BatchRetrieveOrdersRequest type.
BatchRetrieveOrdersResponse
This is a model struct for BatchRetrieveOrdersResponse type.
BatchUpsertCatalogObjectsRequest
This is a model class for BatchUpsertCatalogObjectsRequest type.
BatchUpsertCatalogObjectsResponse
This is a model struct for BatchUpsertCatalogObjectsResponse type.
BulkCreateTeamMembersRequest
This is a model struct for BulkCreateTeamMembersRequest type.
BulkCreateTeamMembersResponse
This is a model struct for BulkCreateTeamMembersResponse type.
BulkUpdateTeamMembersRequest
This is a model struct for BulkUpdateTeamMembersRequest type.
BulkUpdateTeamMembersResponse
This is a model struct for BulkUpdateTeamMembersResponse type.
BusinessHours
The hours of operation for a location.
BusinessHoursPeriod
The hours of operation for a location.
BuyNowPayLaterDetails
Additional details about a Buy Now Pay Later payment type.
CalculateOrderRequest
This is a model struct for CalculateOrderRequest type
CalculateOrderResponse
This is a model struct for CalculateOrderResponse type.
CancelInvoiceRequest
This is a model struct for CancelInvoiceRequest type.
CancelInvoiceResponse
This is a model struct for CancelInvoiceResponse type
CancelPaymentByIdempotencyKeyRequest
This is a model struct for CancelPaymentByIdempotencyRequest type.
CancelPaymentByIdempotencyKeyResponse
This is a model struct for CancelPaymentByIdempotencyKeyResponse type.
CancelPaymentResponse
This is a model struct for CancelPaymentResponse type.
CancelSubscriptionResponse
This is a model struct for CancelSubscriptionResponse type.
Card
Represents the payment details of a card to be used for payments.
CardPaymentDetails
Reflects the current status of a card payment.
CardPaymentTimeline
The timeline for card payments.
CashPaymentDetails
Stores details about a cash payment.
CatalogCategory
A category to which a CatalogItem instance belongs.
CatalogCustomAttributeDefinition
Contains information defining a custom attribute.
CatalogCustomAttributeDefinitionNumberConfig
Configuration associated with Custom Attribute Definitions of type NUMBER.
CatalogCustomAttributeDefinitionSelectionConfig
Configuration associated with SELECTION-type custom attribute definitions.
CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection
A named selection for this SELECTION-type custom attribute definition.
CatalogCustomAttributeDefinitionStringConfig
Configuration associated with Custom Attribute Definitions of type STRING.
CatalogCustomAttributeValue
An instance of a custom attribute.
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.
CatalogInfoResponse
This is a model struct for CatalogInfoResponse type.
CatalogInfoResponseLimits
Limits that apply to the Catalog Info API.
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.
CatalogItemOption
A group of variations for a CatalogItem.
CatalogItemOptionForItem
An option that can be assigned to an item.
CatalogItemOptionValue
An enumerated value that can link a CatalogItemVariation to an item option as one of its item option values.
CatalogItemOptionValueForItemVariation
A CatalogItemOptionValue links an item variation to an item option as an item option value.
CatalogItemVariation
An item variation (i.e., product) 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
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.
CatalogQueryItemVariationsForItemOptionValues
The query filter to return the item variations containing the specified item option value IDs.
CatalogQueryItemsForItemOptions
The query filter to return the items containing the specified item option IDs.
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 result(s) 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.
CatalogQuickAmount
Represents a Quick Amount in the Catalog.
CatalogQuickAmountsSettings
A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts.
CatalogStockConversion
Represents the rule of conversion between a stockable [CatalogItemVariation] and a non-stockable sell-by or receive-by CatalogItemVariation that share the same underlying stock.
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.
CloneOrderRequest
This is a model struct for CloneOrderRequest type.
CloneOrderResponse
This is a model struct for CloneOrderResponse type.
CompletePaymentRequest
This is a model struct for CompletePaymentRequest type.
CompletePaymentResponse
This is a model struct for CompletePaymentResponse type.
Coordinates
Latitude and longitude coordinates.
CreateCardRequest
This is a model class for CreateCardRequest type.
CreateCardResponse
This is a model struct for CreateCardResponse type.
CreateCatalogImageRequest
This is a model class for CreateCatalogImageRequest type.
CreateCatalogImageResponse
This is a model struct for CreateCatalogImageResponse type.
CreateCustomerGroupRequest
CreateCustomerGroupResponse
CreateCustomerRequest
CreateCustomerResponse
CreateGiftCardActivityRequest
This is a model struct for CreateGiftCardActivityRequest type
CreateGiftCardActivityResponse
This is a model struct for CreateGiftCardActivityResponse type
CreateGiftCardRequest
This is a model struct for CreateGiftCardRequest type
CreateGiftCardResponse
This is a model struct for CreateGiftCardResponse type
CreateInvoiceRequest
This is a model struct for CreateInvoiceRequest type
CreateInvoiceResponse
This is a model struct for CreateInvoiceResponse type
CreateLocationRequest
This is a model struct for CreateLocationRequest type
CreateLocationResponse
This is a model struct for CreateLocationResponse type
CreateOrderRequest
This is a model struct for CreateOrderRequest type
CreateOrderResponse
This is a model struct for CreateOrderResponse type
CreatePaymentRequest
This is a model class for CreatePaymentRequest type.
CreatePaymentResponse
This is a model struct for CreatePaymentResponse type.
CreateSubscriptionRequest
This is a model class for CreateSubscriptionRequest type.
CreateSubscriptionResponse
This is a model struct for CreateSubscriptionResponse type.
CreateTeamMemberRequest
This is a model struct for CreateTeamMemberRequest type.
CreateTeamMemberResponse
This is a model struct for CreateTeamMemberResponse type.
Customer
Represents a Square customer profile in the Customer Directory of a Square seller.
CustomerGroup
Represents a group of customer profiles.
CustomerPreferences
Represents communication preferences for the customer profile.
CustomerSegment
Represents a group of customer profiles that match one or more predefined filter criteria.
CustomerTaxIds
Represents the tax ID associated with a [Customer] profile.
DateTime
Represents a Timestamp or DateTime.
DeleteCatalogObjectResponse
This is a model struct for DeleteCatalogObjectResponse type
DeleteCustomerGroupResponse
This is a model struct for DeleteCustomerGroupResponse type
DeleteCustomerResponse
This is a model struct for DeleteCustomerResponse type
DeleteInvoiceParameters
This is a model struct for DeleteInvoiceParameters (query parameters)
DeleteInvoiceResponse
This is a model struct for DeleteInvoiceResponse type
DeleteSubscriptionActionResponse
This is a model struct for DeleteSubscriptionActionResponse type.
DeviceDetails
Details about the device that took the payment.
DigitalWalletDetails
Additional details about WALLET type payments.
DisableCardResponse
This is a model struct for DisableCardResponse type
ExternalPaymentDetails
Stores details about an external payment.
GetInvoiceResponse
This is a model struct for GetInvoiceResponse type
GetPaymentRefundResponse
This is a model struct for GetPaymentRefundResponse type
GetPaymentResponse
This is a model struct for GetPaymentResponse type.
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.
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 a UNBLOCK gift card activity type.
GiftCardActivityUnlinkedActivityRefund
Represents details about a UNLINKED_ACTIVITY_REFUND gift card activity type.
InventoryAdjustment
Represents a change in state or quantity of product inventory at a particular time and location.
InventoryAdjustmentGroup
The current calculated inventory counts for the requested object and locations.
InventoryChange
Changes created for the request.
InventoryCount
The current calculated inventory counts for the requested object and locations.
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.
InvoiceCustomField
An additional seller-defined and customer-facing field to include on the invoice.
InvoiceFilter
Describes query filters to apply.
InvoicePaymentReminder
Describes a payment request reminder (automatic notification) that Square sends to the customer.
InvoicePaymentRequest
Represents a payment request for an [Invoice].
InvoiceQuery
Describes query criteria for searching invoices.
InvoiceRecipient
Represents a snapshot of customer data.
InvoiceRecipientTaxIds
Represents the tax IDs for an invoice recipient.
InvoiceSort
Identifies the sort field and sort order.
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.
LinkCustomerToGiftCardRequest
This is a model struct for LinkCustomerToGiftCardRequest type
LinkCustomerToGiftCardResponse
This is a model struct for LinkCustomerToGiftCardResponse type
ListCardsParameters
This is a model struct for ListCardsParameters (query parameters)
ListCardsResponse
This is a model struct for ListCardsResponse type
ListCatalogParameters
This is a model struct for ListCatalogParameters (query parameters)
ListCatalogResponse
This is a model struct for ListCatalogResponse type
ListCustomerGroupsParameters
This is a model struct for ListCustomerGroupsParameters (query parameters)
ListCustomerGroupsResponse
This is a model struct for ListCustomerGroupsResponse type
ListCustomerSegmentsParameters
This is a model struct for ListCustomerSegmentsParameters (query parameters)
ListCustomerSegmentsResponse
This is a model struct for ListCustomerSegmentsResponse type
ListCustomersParameters
This is a model struct for ListCustomersParameters (query parameters)
ListCustomersResponse
This is a model struct for ListCustomersResponse type
ListGiftCardActivitiesParameters
This is a model struct for ListGiftCardActivitiesParameters (query parameters)
ListGiftCardActivitiesResponse
This is a model struct for ListGiftCardActivitiesResponse type
ListGiftCardsParameters
This is a model struct for ListGiftCardsParameters (query parameters)
ListGiftCardsResponse
This is a model struct for ListGiftCardsResponse type
ListInvoicesParameters
This is a model struct for ListInvoicesParameters (query parameters)
ListInvoicesResponse
This is a model struct for ListInvoicesResponse type
ListLocationsResponse
This is a model struct for ListLocationsResponse type
ListPaymentRefundsParameters
This is a model struct for ListPaymentRefundsParameters (query parameters)
ListPaymentRefundsResponse
This is a model struct for ListPaymentRefundsResponse type
ListPaymentsParameters
This is a model struct for ListPaymentsParameters (query parameters)
ListPaymentsResponse
This is a model struct for ListPaymentsResponse type
ListSubscriptionEventsParameters
This is a model struct for ListSubscriptionEventsParameters (query parameters)
ListSubscriptionEventsResponse
This is a model struct for ListSubscriptionEventsResponse type
Location
Represents one of a business’ locations.
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.
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
This is a model struct for OrderFulfillment type.
OrderFulfillmentDeliveryDetails
Describes delivery details of an order fulfillment.
OrderFulfillmentFulfillmentEntry
This is a model struct for OrderFulfillmentFulfillmentEntry type.
OrderFulfillmentPickupDetails
This is a model struct for OrderFulfillmentPickupDetails type.
OrderFulfillmentPickupDetailsCurbsidePickupDetails
Specific details for curbside pickup.
OrderFulfillmentRecipient
Contains information about the recipient of a fulfillment.
OrderFulfillmentShipmentDetails
Contains the details necessary to fulfill a shipment order.
OrderLineItem
Represents a line item in an order.
OrderLineItemAppliedDiscount
Represents an applied portion of a discount to a line item in an order.
OrderLineItemAppliedTax
Represents an applied portion of a tax to a line item in an order.
OrderLineItemDiscount
Represents a discount that applies to one or more line items in an order.
OrderLineItemModifier
A [CatalogModifier].
OrderLineItemPricingBlocklists
Describes pricing adjustments that are blocked from manual and automatic application to a line item.
OrderLineItemPricingBlocklistsBlockedDiscount
A discount to block from applying to a line item.
OrderLineItemPricingBlocklistsBlockedTax
A tax to block from applying to a line item.
OrderLineItemTax
Represents a tax that applies to one or more line item in the order.
OrderMoneyAmounts
A collection of various money amounts.
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.
OrderReturn
The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.
OrderReturnDiscount
Represents a discount being returned that applies to one or more return line items in an order.
OrderReturnLineItem
The line item being returned in an order.
OrderReturnLineItemModifier
A line item modifier being returned.
OrderReturnServiceCharge
Represents the service charge applied to the original order.
OrderReturnTax
Represents a tax being returned that applies to one or more return line items in an order.
OrderReward
Represents a reward that can be applied to an order if the necessary reward tier criteria are met.
OrderRoundingAdjustment
A rounding adjustment of the money being returned.
OrderServiceCharge
Represents a service charge applied to an order.
OrderSource
Represents the origination details of an order.
PauseSubscriptionRequest
This is the model struct for the PauseSubscriptionRequest type.
PauseSubscriptionResponse
This is the model struct for the PauseSubscriptionResponse type.
PayOrderRequest
This is a model struct for PayOrderRequest type
PayOrderResponse
This is a model struct for PayOrderResponse type
Payment
Represents a payment processed by the Square API.
PaymentRefund
Represents a refund of a payment made using Square.
ProcessingFee
Represents the Square processing fee.
PublishInvoiceRequest
This is a model struct for PublishInvoiceRequest type.
PublishInvoiceResponse
This is a model struct for PublishInvoiceResponse type
Refund
Represents a refund processed for a Square transaction.
RefundPaymentRequest
This is a model struct for RefundPaymentRequest type
RefundPaymentResponse
This is a model struct for RefundPaymentResponse type
RegisterDomainRequest
This is a model struct for RegisterDomainRequest type.
RegisterDomainResponse
This is a model struct for RegisterDomainResponse type
ResumeSubscriptionRequest
This is the model struct for the ResumeSubscriptionRequest type.
ResumeSubscriptionResponse
This is the model struct for the ResumeSubscriptionResponse type.
RetrieveCardResponse
This is a model struct for RetrieveCardResponse type
RetrieveCatalogObjectParameters
This is a model struct for RetrieveCatalogObjectParameters (query parameters)
RetrieveCatalogObjectResponse
This is a model struct for RetrieveCatalogObjectResponse type
RetrieveCustomerGroupResponse
This is a model struct for RetrieveCustomerGroupResponse type
RetrieveCustomerResponse
This is a model struct for RetrieveCustomerResponse type
RetrieveCustomerSegmentResponse
This is a model struct for RetrieveCustomerSegmentResponse type
RetrieveGiftCardFromGANRequest
This is a model struct for RetrieveGiftCardFromGANRequest type
RetrieveGiftCardFromGANResponse
This is a model struct for RetrieveGiftCardFromGANResponse type
RetrieveGiftCardFromNonceRequest
This is a model struct for RetrieveGiftCardFromNonceRequest type
RetrieveGiftCardFromNonceResponse
This is a model struct for RetrieveGiftCardFromNonceResponse type
RetrieveGiftCardResponse
This is a model struct for RetrieveGiftCardResponse type
RetrieveInventoryAdjustmentResponse
This is a model struct for RetrieveInventoryAdjustmentResponse type.
RetrieveInventoryCountParams
RetrieveInventoryCountResponse
This is a model struct for RetrieveInventoryCountResponse type.
RetrieveInventoryPhysicalCount
This is a model struct for RetrieveInventoryPhysicalCount type.
RetrieveInventoryTransferResponse
This is a model struct for RetrieveInventoryTransferResponse type.
RetrieveLocationResponse
This is a model struct for RetrieveLocationResponse type
RetrieveOrderResponse
This is a model struct for RetrieveOrderResponse type.
RetrieveSubscriptionParameters
This is a model struct for RetrieveSubscriptionParameters (query parameters)
RetrieveSubscriptionResponse
This is a model struct for the RetrieveSubscriptionResponse type.
RetrieveTeamMemberResponse
This is a model struct for RetrieveTeamMemberResponse type.
RetrieveWageSettingResponse
This is a model struct for RetrieveWageSettingResponse type.
RiskEvaluation
Represents fraud risk information for the associated payment.
SearchCatalogItemsRequest
This is a model struct for SearchCatalogItemsRequest type.
SearchCatalogItemsResponse
This is a model struct for SearchCatalogItemsResponse type
SearchCatalogObjectsRequest
This is a model struct for SearchCatalogObjectsRequest type.
SearchCatalogObjectsResponse
This is a model struct for SearchCatalogObjectsResponse type
SearchCustomerCreationSourceFilter
Filter based on order fulfillment information
SearchCustomersDateTimeFilter
Filter for Customer objects based on whether their CREATED_AT timestamps fall within a specified time range.
SearchCustomersFilter
Filtering criteria to use for a SearchCustomers request.
SearchCustomersQuery
Contains query criteria for the search.
SearchCustomersRequest
This is a model struct for SearchCustomersRequest type.
SearchCustomersResponse
This is a model struct for SearchCustomersResponse type
SearchCustomersSort
Sorting criteria for a SearchCustomers request.
SearchCustomersTextFilter
SearchInvoicesRequest
This is a model struct for SearchInvoicesRequest type.
SearchInvoicesResponse
This is a model struct for SearchInvoicesResponse type
SearchOrdersCustomerFilter
A filter based on the order customer_id and any tender customer_id associated with the order.
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.
SearchOrdersRequest
This is a model struct for SearchOrdersRequest type.
SearchOrdersResponse
This is a model struct for SearchOrdersResponse type
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.
SearchSubscriptionsRequest
This is a model struct for SearchSubscriptionsRequest type.
SearchSubscriptionsResponse
This is a model struct for SearchSubscriptionsResponse type.
SearchTeamMembersFilter
Represents a filter used in a search for TeamMember objects.
SearchTeamMembersQuery
Represents the parameters in a search for TeamMember objects.
SearchTeamMembersRequest
This is a model struct for SearchTeamMembersRequest type.
SearchTeamMembersResponse
This is a model struct for SearchTeamMembersResponse type.
SourceApplication
Provides 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.
SubscriptionAction
Represents an action as a pending change to a subscription.
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.
SubscriptionSource
The origination details of the subscription.
SwapPlanRequest
This is a model struct for the SwapPlanRequest type.
SwapPlanResponse
This is a model struct for the SwapPlanResponse type.
TaxIds
Identifiers for the location used by various governments for tax purposes.
TeamMember
A record representing an individual team member for a business.
TeamMemberAssignedLocations
A record representing an individual team member for a business.
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.
TimeRange
Represents a generic time range.
TransactionDeprecated
Represents a transaction processed with Square, either with the Connect API or with Square Point of Sale.
UnlinkCustomerFromGiftCardRequest
This is a model struct for UnlinkCustomerFromGiftCardRequest type
UnlinkCustomerFromGiftCardResponse
This is a model struct for UnlinkCustomerFromGiftCardResponse type
UpdateCatalogImageRequest
This is a model struct for UpdateCatalogImageRequest type.
UpdateCatalogImageResponse
This is a model struct for UpdateCatalogImageResponse type.
UpdateCustomerGroupRequest
This is a model struct for UpdateCustomerGroupRequest type.
UpdateCustomerGroupResponse
This is a model struct for UpdateCustomerGroupResponse type.
UpdateCustomerRequest
This is a model struct for UpdateCustomerRequest type.
UpdateCustomerResponse
This is a model struct for UpdateCustomerResponse type.
UpdateInvoiceRequest
This is a model struct for UpdateInvoiceRequest type.
UpdateInvoiceResponse
This is a model struct for UpdateInvoiceResponse type.
UpdateItemModifierListsRequest
This is a model struct for UpdateItemModifierListsRequest type.
UpdateItemModifierListsResponse
This is a model struct for UpdateItemModifierListsResponse type.
UpdateItemTaxesRequest
This is a model struct for UpdateItemTaxesRequest type.
UpdateItemTaxesResponse
This is a model struct for UpdateItemTaxesResponse type.
UpdateLocationRequest
This is a model struct for the UpdateLocationRequest type
UpdateLocationResponse
This is a model struct for UpdateLocationResponse type
UpdateOrderRequest
This is a model struct for UpdateOrderRequest type.
UpdateOrderResponse
This is a model struct for UpdateOrderResponse type.
UpdatePaymentRequest
This is a model struct for UpdatePaymentRequest type.
UpdatePaymentResponse
This is a model struct for UpdatePaymentResponse type.
UpdateSubscriptionRequest
This is a model struct for UpdateSubscriptionRequest type.
UpdateSubscriptionResponse
This is a model struct for UpdateSubscriptionResponse type.
UpdateTeamMemberRequest
This is a model struct for UpdateTeamMemberRequest type.
UpdateTeamMemberResponse
This is a model struct for UpdateTeamMemberResponse type.
UpdateWageSettingRequest
This is a model struct for UpdateWageSettingRequest type.
UpdateWageSettingResponse
This is a model struct for UpdateWageSettingResponse type.
UpsertCatalogObjectRequest
This is a model struct for UpsertCatalogObjectRequest type.
UpsertCatalogObjectResponse
This is a model struct for UpsertCatalogObjectResponse type.
WageSetting
An object representing a team member’s wage information.