Docs.rs
squareup-2.13.0
Platform
i686-pc-windows-msvc
x86_64-apple-darwin
x86_64-pc-windows-msvc
x86_64-unknown-linux-gnu
Feature flags
docs.rs
About docs.rs
Badges
Builds
Metadata
Shorthand URLs
Download
Rustdoc JSON
Build queue
Privacy policy
Rust
Rust website
The Book
Standard Library API Reference
Rust by Example
The Cargo Guide
Clippy Documentation
squareup 2.13.0
Rust SDK for the Square Developer API
Crate
Source
Builds
Feature flags
Documentation
..
enums
errors
accepted_payment_methods.rs
ach_details.rs
add_group_to_customer_response.rs
additional_recipient.rs
address.rs
afterpay_details.rs
application_details.rs
appointment_segment.rs
authorize_oauth_parameters.rs
authorize_oauth_response.rs
availability.rs
bank_account_payment_details.rs
batch_change_inventory_request.rs
batch_change_inventory_response.rs
batch_delete_catalog_objects_request.rs
batch_delete_catalog_objects_response.rs
batch_retrieve_catalog_objects_request.rs
batch_retrieve_catalog_objects_response.rs
batch_retrieve_inventory_changes_request.rs
batch_retrieve_inventory_changes_response.rs
batch_retrieve_inventory_counts_request.rs
batch_retrieve_inventory_counts_response.rs
batch_retrieve_orders_request.rs
batch_retrieve_orders_response.rs
batch_upsert_catalog_objects_request.rs
batch_upsert_catalog_objects_response.rs
booking.rs
booking_creator_details.rs
booking_event_data.rs
booking_event_object.rs
booking_event_webhook_response.rs
bulk_create_customer_data.rs
bulk_create_customers_request.rs
bulk_create_customers_response.rs
bulk_create_team_members_request.rs
bulk_create_team_members_response.rs
bulk_delete_customers_request.rs
bulk_delete_customers_response.rs
bulk_retrieve_bookings_request.rs
bulk_retrieve_bookings_response.rs
bulk_retrieve_customers_request.rs
bulk_retrieve_customers_response.rs
bulk_retrieve_team_member_booking_profiles_request.rs
bulk_retrieve_team_member_booking_profiles_response.rs
bulk_swap_plan_request.rs
bulk_swap_plan_response.rs
bulk_update_customer_data.rs
bulk_update_customers_request.rs
bulk_update_customers_response.rs
bulk_update_team_members_request.rs
bulk_update_team_members_response.rs
bulk_upsert_customer_custom_attributes_request.rs
bulk_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request.rs
bulk_upsert_customer_custom_attributes_response.rs
bulk_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response.rs
business_appointment_settings.rs
business_booking_profile.rs
business_hours.rs
business_hours_period.rs
buy_now_pay_later_details.rs
calculate_order_request.rs
calculate_order_response.rs
cancel_booking_request.rs
cancel_booking_response.rs
cancel_invoice_request.rs
cancel_invoice_response.rs
cancel_payment_by_idempotency_key_request.rs
cancel_payment_by_idempotency_key_response.rs
cancel_payment_response.rs
cancel_subscription_response.rs
card.rs
card_event_data.rs
card_event_object.rs
card_event_webhook_response.rs
card_payment_details.rs
card_payment_timeline.rs
cash_app_details.rs
cash_payment_details.rs
catalog_availability_period.rs
catalog_category.rs
catalog_custom_attribute_definition.rs
catalog_custom_attribute_definition_number_config.rs
catalog_custom_attribute_definition_selection_config.rs
catalog_custom_attribute_definition_selection_config_custom_attribute_selection.rs
catalog_custom_attribute_definition_string_config.rs
catalog_custom_attribute_value.rs
catalog_discount.rs
catalog_ecom_seo_data.rs
catalog_event_data.rs
catalog_id_mapping.rs
catalog_image.rs
catalog_info_response.rs
catalog_info_response_limits.rs
catalog_item.rs
catalog_item_food_and_beverage_details.rs
catalog_item_food_and_beverage_details_dietary_preference.rs
catalog_item_food_and_beverage_details_ingredient.rs
catalog_item_modifier_list_info.rs
catalog_item_option.rs
catalog_item_option_for_item.rs
catalog_item_option_value.rs
catalog_item_option_value_for_item_variation.rs
catalog_item_variation.rs
catalog_measurement_unit.rs
catalog_modifier.rs
catalog_modifier_list.rs
catalog_modifier_override.rs
catalog_object.rs
catalog_object_batch.rs
catalog_object_category.rs
catalog_pricing_rule.rs
catalog_product_set.rs
catalog_query.rs
catalog_query_exact.rs
catalog_query_item_variations_for_item_option_values.rs
catalog_query_items_for_item_options.rs
catalog_query_items_for_modifier_list.rs
catalog_query_items_for_tax.rs
catalog_query_prefix.rs
catalog_query_range.rs
catalog_query_set.rs
catalog_query_sorted_attribute.rs
catalog_query_text.rs
catalog_quick_amount.rs
catalog_quick_amounts_settings.rs
catalog_stock_conversion.rs
catalog_subscription_plan.rs
catalog_subscription_plan_variation.rs
catalog_tax.rs
catalog_time_period.rs
catalog_v1_id.rs
catalog_version_updated_event_catalog_version.rs
catalog_version_updated_event_object.rs
catalog_version_updated_webhook_response.rs
category_path_to_root_node.rs
change_billing_anchor_date_request.rs
change_billing_anchor_date_response.rs
checkout_location_settings.rs
checkout_location_settings_branding.rs
checkout_location_settings_coupons.rs
checkout_location_settings_policy.rs
checkout_location_settings_tipping.rs
checkout_merchant_settings.rs
checkout_merchant_settings_payment_methods.rs
checkout_merchant_settings_payment_methods_afterpay_clearpay.rs
checkout_merchant_settings_payment_methods_afterpay_clearpay_eligibility_range.rs
checkout_merchant_settings_payment_methods_payment_method.rs
checkout_options.rs
clearpay_details.rs
clone_order_request.rs
clone_order_response.rs
complete_payment_request.rs
complete_payment_response.rs
coordinates.rs
create_booking_request.rs
create_booking_response.rs
create_card_request.rs
create_card_response.rs
create_catalog_image_request.rs
create_catalog_image_response.rs
create_customer_custom_attribute_definition_request.rs
create_customer_custom_attribute_definition_response.rs
create_customer_group_request.rs
create_customer_group_response.rs
create_customer_request.rs
create_customer_response.rs
create_gift_card_activity_request.rs
create_gift_card_activity_response.rs
create_gift_card_request.rs
create_gift_card_response.rs
create_invoice_attachment_request.rs
create_invoice_attachment_response.rs
create_invoice_request.rs
create_invoice_response.rs
create_job_request.rs
create_job_response.rs
create_location_request.rs
create_location_response.rs
create_order_request.rs
create_order_response.rs
create_payment_link_request.rs
create_payment_link_response.rs
create_payment_request.rs
create_payment_response.rs
create_subscription_request.rs
create_subscription_response.rs
create_team_member_request.rs
create_team_member_response.rs
create_webhook_subscription_request.rs
create_webhook_subscription_response.rs
custom_attribute.rs
custom_attribute_definition.rs
custom_attribute_filter.rs
custom_field.rs
customer.rs
customer_address_filter.rs
customer_custom_attribute_filter.rs
customer_custom_attribute_filter_value.rs
customer_custom_attribute_filters.rs
customer_details.rs
customer_event_data.rs
customer_event_object.rs
customer_event_webhook_response.rs
customer_group.rs
customer_preferences.rs
customer_segment.rs
customer_tax_ids.rs
date_time.rs
delete_catalog_object_response.rs
delete_customer_custom_attribute_definition_response.rs
delete_customer_custom_attribute_response.rs
delete_customer_group_response.rs
delete_customer_parameters.rs
delete_customer_response.rs
delete_invoice_attachment_response.rs
delete_invoice_parameters.rs
delete_invoice_response.rs
delete_payment_link_response.rs
delete_subscription_action_response.rs
delete_webhook_subscription_response.rs
destination_details.rs
destination_details_card_refund_details.rs
destination_details_cash_refund_details.rs
destination_details_external_refund_details.rs
device_details.rs
digital_wallet_details.rs
disable_card_response.rs
event_type_metadata.rs
external_payment_details.rs
filter_value.rs
float_number_range.rs
get_invoice_response.rs
get_payment_refund_response.rs
get_payment_response.rs
gift_card.rs
gift_card_activity.rs
gift_card_activity_activate.rs
gift_card_activity_adjust_decrement.rs
gift_card_activity_adjust_increment.rs
gift_card_activity_block.rs
gift_card_activity_clear_balance.rs
gift_card_activity_deactivate.rs
gift_card_activity_event_data.rs
gift_card_activity_event_object.rs
gift_card_activity_event_webhook_response.rs
gift_card_activity_import.rs
gift_card_activity_import_reversal.rs
gift_card_activity_load.rs
gift_card_activity_redeem.rs
gift_card_activity_refund.rs
gift_card_activity_transfer_balance_from.rs
gift_card_activity_transfer_balance_to.rs
gift_card_activity_unblock.rs
gift_card_activity_unlinked_activity_refund.rs
gift_card_event_data.rs
gift_card_event_object.rs
gift_card_event_webhook_response.rs
inventory_adjustment.rs
inventory_adjustment_group.rs
inventory_change.rs
inventory_count.rs
inventory_count_updated_event_data.rs
inventory_count_updated_event_object.rs
inventory_event_webhook_response.rs
inventory_physical_count.rs
inventory_transfer.rs
invoice.rs
invoice_accepted_payment_methods.rs
invoice_attachment.rs
invoice_custom_field.rs
invoice_event_data.rs
invoice_event_object.rs
invoice_event_webhook_response.rs
invoice_filter.rs
invoice_payment_reminder.rs
invoice_payment_request.rs
invoice_query.rs
invoice_recipient.rs
invoice_recipient_tax_ids.rs
invoice_sort.rs
iso_8601_date.rs
item_variation_location_overrides.rs
job.rs
job_assignment.rs
link_customer_to_gift_card_request.rs
link_customer_to_gift_card_response.rs
list_bookings_parameters.rs
list_bookings_response.rs
list_cards_parameters.rs
list_cards_response.rs
list_catalog_parameters.rs
list_catalog_response.rs
list_customer_custom_attribute_definitions_parameters.rs
list_customer_custom_attribute_definitions_response.rs
list_customer_custom_attributes_parameters.rs
list_customer_custom_attributes_response.rs
list_customer_groups_parameters.rs
list_customer_groups_response.rs
list_customer_segments_parameters.rs
list_customer_segments_response.rs
list_customers_parameters.rs
list_customers_response.rs
list_gift_card_activities_parameters.rs
list_gift_card_activities_response.rs
list_gift_cards_parameters.rs
list_gift_cards_response.rs
list_invoices_parameters.rs
list_invoices_response.rs
list_jobs_parameters.rs
list_jobs_response.rs
list_location_booking_profiles_parameters.rs
list_location_booking_profiles_response.rs
list_locations_response.rs
list_payment_link_response.rs
list_payment_links_parameters.rs
list_payment_refunds_parameters.rs
list_payment_refunds_response.rs
list_payments_parameters.rs
list_payments_response.rs
list_subscription_events_parameters.rs
list_subscription_events_response.rs
list_team_member_booking_profiles_parameters.rs
list_team_member_booking_profiles_response.rs
list_webhook_event_types_response.rs
list_webhook_subscriptions_params.rs
list_webhook_subscriptions_response.rs
location.rs
location_booking_profile.rs
location_event_data.rs
location_event_webhook_response.rs
location_settings_updated_event_data.rs
location_settings_updated_event_object.rs
measurement_unit.rs
measurement_unit_custom.rs
merchant_settings_updated_event_data.rs
merchant_settings_updated_event_object.rs
mod.rs
modifier_location_overrides.rs
money.rs
oauth_authorization_revoked_event_data.rs
oauth_authorization_revoked_event_object.rs
oauth_authorization_revoked_event_revocation_object.rs
oauth_authorization_revoked_webhook_response.rs
obtain_token_oauth_request.rs
obtain_token_oauth_response.rs
offline_payment_details.rs
online_checkout_location_settings_updated_webhook_response.rs
online_checkout_merchant_settings_updated_webhook_response.rs
order.rs
order_created.rs
order_created_object.rs
order_entry.rs
order_event_data.rs
order_event_webhook_response.rs
order_fulfillment.rs
order_fulfillment_fulfillment_entry.rs
order_fulfillment_pickup_details.rs
order_fulfillment_pickup_details_curbside_pickup_details.rs
order_fulfillment_recipient.rs
order_fulfillment_shipment_details.rs
order_fulfillment_updated.rs
order_fulfillment_updated_object.rs
order_fulfillment_updated_update.rs
order_fullfillment_delivery_details.rs
order_line_item.rs
order_line_item_applied_discount.rs
order_line_item_applied_service_charge.rs
order_line_item_applied_tax.rs
order_line_item_discount.rs
order_line_item_modifier.rs
order_line_item_pricing_blocklists.rs
order_line_item_pricing_blocklists_blocked_discount.rs
order_line_item_pricing_blocklists_blocked_tax.rs
order_line_item_tax.rs
order_money_amounts.rs
order_pricing_options.rs
order_quantity_unit.rs
order_return.rs
order_return_discount.rs
order_return_line_item.rs
order_return_line_item_modifier.rs
order_return_service_charge.rs
order_return_tax.rs
order_return_tip.rs
order_reward.rs
order_rounding_adjustment.rs
order_service_charge.rs
order_source.rs
order_updated.rs
order_updated_object.rs
pause_subscription_request.rs
pause_subscription_response.rs
pay_order_request.rs
pay_order_response.rs
payment.rs
payment_event_data.rs
payment_event_object.rs
payment_event_webhook_response.rs
payment_link.rs
payment_link_related_resources.rs
payment_refund.rs
phase.rs
phase_input.rs
pre_populated_data.rs
processing_fee.rs
publish_invoice_request.rs
publish_invoice_response.rs
quick_pay.rs
range.rs
refund.rs
refund_event_data.rs
refund_event_object.rs
refund_event_webhook_response.rs
refund_payment_request.rs
refund_payment_response.rs
register_domain_request.rs
register_domain_response.rs
remove_group_from_customer_response.rs
resume_subscription_request.rs
resume_subscription_response.rs
retrieve_booking_response.rs
retrieve_business_booking_profile_response.rs
retrieve_card_response.rs
retrieve_catalog_object_parameters.rs
retrieve_catalog_object_response.rs
retrieve_customer_custom_attribute_definition_parameters.rs
retrieve_customer_custom_attribute_definition_response.rs
retrieve_customer_custom_attribute_parameters.rs
retrieve_customer_custom_attribute_response.rs
retrieve_customer_group_response.rs
retrieve_customer_response.rs
retrieve_customer_segment_response.rs
retrieve_gift_card_from_gan_request.rs
retrieve_gift_card_from_gan_response.rs
retrieve_gift_card_from_nonce_request.rs
retrieve_gift_card_from_nonce_response.rs
retrieve_gift_card_response.rs
retrieve_inventory_adjustment_response.rs
retrieve_inventory_count_parameters.rs
retrieve_inventory_count_response.rs
retrieve_inventory_physical_count_response.rs
retrieve_inventory_transfer_response.rs
retrieve_job_response.rs
retrieve_location_booking_profile_response.rs
retrieve_location_response.rs
retrieve_location_settings_response.rs
retrieve_merchant_settings_response.rs
retrieve_order_response.rs
retrieve_payment_link_response.rs
retrieve_subscription_parameters.rs
retrieve_subscription_response.rs
retrieve_team_member_booking_profile_response.rs
retrieve_team_member_response.rs
retrieve_token_status_response.rs
retrieve_wage_setting_response.rs
retrieve_webhook_subscription_response.rs
revoke_token_oauth_request.rs
revoke_token_oauth_response.rs
risk_evaluation.rs
search_availability_filter.rs
search_availability_query.rs
search_availability_request.rs
search_availability_response.rs
search_catalog_items_request.rs
search_catalog_items_response.rs
search_catalog_objects_request.rs
search_catalog_objects_response.rs
search_customers_creation_source_filter.rs
search_customers_date_time_filter.rs
search_customers_filter.rs
search_customers_query.rs
search_customers_request.rs
search_customers_response.rs
search_customers_sort.rs
search_customers_text_filter.rs
search_invoices_request.rs
search_invoices_response.rs
search_orders_customer_filter.rs
search_orders_date_time_filter.rs
search_orders_filter.rs
search_orders_fulfillment_filter.rs
search_orders_query.rs
search_orders_request.rs
search_orders_response.rs
search_orders_sort.rs
search_orders_source_filter.rs
search_orders_state_filter.rs
search_subscriptions_filter.rs
search_subscriptions_query.rs
search_subscriptions_request.rs
search_subscriptions_response.rs
search_team_members_filter.rs
search_team_members_query.rs
search_team_members_request.rs
search_team_members_response.rs
segment_filter.rs
shipping_fee.rs
source_application.rs
square_account_details.rs
standard_unit_description.rs
standard_unit_description_group.rs
subscription.rs
subscription_action.rs
subscription_event.rs
subscription_event_data.rs
subscription_event_info.rs
subscription_event_object.rs
subscription_event_webhook_response.rs
subscription_phase.rs
subscription_pricing.rs
subscription_source.rs
subscription_test_result.rs
swap_plan_request.rs
swap_plan_response.rs
tax_ids.rs
team_member.rs
team_member_assigned_locations.rs
team_member_booking_profile.rs
team_member_event_data.rs
team_member_event_object.rs
team_member_event_webhook_response.rs
tender.rs
tender_bank_account_details.rs
tender_buy_now_pay_later_details.rs
tender_card_details.rs
tender_cash_details.rs
tender_square_account_details.rs
test_webhook_subscription_request.rs
test_webhook_subscription_response.rs
time_range.rs
transaction.rs
unlink_customer_from_gift_card_request.rs
unlink_customer_from_gift_card_response.rs
update_booking_request.rs
update_booking_response.rs
update_catalog_image_request.rs
update_catalog_image_response.rs
update_customer_custom_attribute_definition_request.rs
update_customer_custom_attribute_definition_response.rs
update_customer_group_request.rs
update_customer_group_response.rs
update_customer_request.rs
update_customer_response.rs
update_invoice_request.rs
update_invoice_response.rs
update_item_modifier_lists_request.rs
update_item_modifier_lists_response.rs
update_item_taxes_request.rs
update_item_taxes_response.rs
update_job_request.rs
update_job_response.rs
update_location_request.rs
update_location_response.rs
update_location_settings_request.rs
update_location_settings_response.rs
update_merchant_settings_request.rs
update_merchant_settings_response.rs
update_order_request.rs
update_order_response.rs
update_payment_link_request.rs
update_payment_link_response.rs
update_payment_request.rs
update_payment_response.rs
update_subscription_request.rs
update_subscription_response.rs
update_team_member_request.rs
update_team_member_response.rs
update_wage_setting_request.rs
update_wage_setting_response.rs
update_webhook_subscription_request.rs
update_webhook_subscription_response.rs
update_webhook_subscription_signature_key_request.rs
update_webhook_subscription_signature_key_response.rs
upsert_catalog_object_request.rs
upsert_catalog_object_response.rs
upsert_customer_custom_attribute_request.rs
upsert_customer_custom_attribute_response.rs
wage_setting.rs
webhook_subscription.rs