Module square_api_client::models::enums
source · Expand description
Enums live here
Enums
A type of bank account performing a transfer for payment.
A list of products to return to external callers.
An ownership type of a bank account performing a transfer for payment.
A type of bank transfer
Indicates a card’s brand, such as
VISA or MASTERCARD.Status code returned from the Address Verification System (AVS) check.
Status code returned from the Card Verification Value (CVV) check.
Method used to enter a card’s details for payment.
Card payment state.
Method to verify cardholder’s identity.
Results of cardholder verification.
Indicates a card’s prepaid type, such as
NOT_PREPAID or PREPAID.Model for CardSquareProduct enum
Indicates a card’s type, such as
CREDIT or DEBIT.Defines the visibility of a custom attribute to applications other than their creating
application.
Defines the visibility of a custom attribute to sellers in Square client applications, Square
APIs or in Square UIs (including Square Point of Sale applications and Square Dashboard).
Defines the possible types for a custom attribute.
Indicates whether this discount should reduce the price used to calculate tax.
How to apply a CatalogDiscount to a CatalogItem.
The type of a CatalogItem.
Indicates whether a CatalogModifierList supports multiple selections.
Possible types of CatalogObjects returned from the catalog, each containing type-specific
properties in the
*_data field corresponding to the specfied object type.Indicates whether the price of a CatalogItemVariation should be entered manually at the time of
sale.
Determines the type of a specific Quick Amount.
Determines a seller’s option on Quick Amounts feature.
Supported timings when a pending change, as an action, takes place to a subscription.
Indicates the country associated with another entity, such as a business.
Indicates the associated currency for an amount of money.
Indicates the method used to create the customer profile.
The rule to include or exclude a certain set of values.
Indicates the specific day of the week.
Indicates which high-level category of error has occurred during a request to the Connect API.
Indicates which high-level category of error has occurred during a request to the Connect API.
Indicates which products matched by a CatalogPricingRule will be excluded if the pricing rule
uses an exclude set.
The type of external payment the seller received.
Indicates the status of a gift card redemption.
Indicates the type of the gift card activity.
Indicates the source that generated the gift card account number (GAN).
Indicates the gift card state.
Indicates the gift card type.
Indicates whether Square should alert the merchant when the inventory quantity of a
CatalogItemVariation is low.
Indicates how the inventory change is applied.
A type of state for the related quantity of items
Indicates the automatic payment method for an invoice payment request.
Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF
copies of the invoice.
Indicates how Square delivers the [Invoice] to the customer.
The status of a payment request reminder.
Indicates the type of the payment request.
Indicates the status of an invoice.
Indicates the status of an invoice.
Enumerates the possible pay types that a job can be assigned.
A language in BCP 47 format. For more
information, see Location language
code.
The capabilities a location might have.
A location’s status.
A location’s type.
Unit of area used to measure a quantity.
Reserved for API integrations that lack the ability to specify a real measurement unit.
The unit of length used to measure a quantity.
Unit of time used to measure a quantity (a duration).
Describes the type of this unit and indicates which field contains the unit information.
The unit of volume used to measure a quantity.
Unit of weight used to measure a quantity.
The
line_item_application describes what order line items this fulfillment applies to.The schedule type of the pickup fulfillment.
The current state of this fulfillment.
The type of fulfillment.
Indicates whether this is a line-item or order-level discount.
Indicates how the discount is applied to the associated line item or order.
Represents the line item type.
Indicates whether this is a line-item or order-level tax.
Indicates how the tax is applied to the associated line item or order.
Represents a phase in the process of calculating order totals.
The type of the service charge.
The state of the order.
Actions that can be performed on a [Payment]
Actions that can be applied to [Payment]s when the
delay_duration has elapsed.Indicates a refund’s current status.
Sources from which [Payment]s can be taken.
The status of a [Payment]
The type of fee assessed or adjusted.
Indicates the Square product used to generate an inventory change.
Indicates a refund’s current status.
The status of the domain registration.
The risk level associated with a payment.
Defines supported stock levels of the item inventory.
Reserved for API integrations that lack the ability to specify a real measurement unit.
Use one or more customer attributes as the sort key to sort searched customer profiles.
For example, use the creation date (created_at) of customers or default attributes as the sort key.
The order (e.g., chronological or alphabetical) in which results from a request are returned.
Supported types of an action as a pending change to a subscription.
Determines the billing cadence of a [Subscription]
Supported info codes of a subscription event.
Supported types of an event occurred to a subscription.
Supported subscription statuses.
When to calculate the taxes due on a cart.
Whether to the tax amount should be additional to or included in the CatalogItem price.
Enumerates the possible assignment types that the team member can have.
Enumerates the possible statuses the team member can have within a business.
Indicates the method used to enter the card’s details.
Indicates the card transaction’s current status.
Indicates a tender’s type.
An IANA time zone identifier for a time zone.
Indicates the Square product used to process a transaction.